pay-gateway-qa.rguest.com
Open in
urlscan Pro
40.112.243.52
Public Scan
Submitted URL: https://pay-gateway-qa.rguest.com/
Effective URL: https://pay-gateway-qa.rguest.com/swagger/ui/index
Submission: On September 02 via automatic, source certstream-suspicious — Scanned from DE
Effective URL: https://pay-gateway-qa.rguest.com/swagger/ui/index
Submission: On September 02 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 59 forms found in the DOM
<form id="api_selector">
<div class="input"><input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text"></div>
<div class="input"><input placeholder="api_key" id="input_apiKey" name="apiKey" type="text"></div>
<div class="input"><a id="explore" class="header__btn" href="#" data-sw-translate="">Explore</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.34969330823251155">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.34969330823251155"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5584871021040678" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5584871021040678">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AdyenDeviceRequest {</span>
<div><span class="propName ">saleTopoiRequest</span> (<span class="propType">SaletoPOIRequest</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">SaletoPOIRequest {</span>
<div><span class="propName ">diagnosisRequest</span> (<span class="propType">DiagnosisRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">reversalRequest</span> (<span class="propType">ReversalRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">displayRequest</span> (<span class="propType">DisplayRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">inputRequest</span> (<span class="propType">InputRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">abortRequest</span> (<span class="propType">AbortRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">transactionStatusRequest</span> (<span class="propType">TransactionStatusRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">printRequest</span> (<span class="propType">PrintRequest</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">eventNotification</span> (<span class="propType">EventNotification</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">securityTrailer</span> (<span class="propType">SecurityTrailer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">nexoBlob</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">messageHeader</span> (<span class="propType">MessageHeader</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">paymentRequest</span> (<span class="propType">PaymentRequest</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">DiagnosisRequest {</span>
<div><span class="propName ">hostDiagnosisFlag</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">ReversalRequest {</span>
<div><span class="propName ">reversalReason</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">originalpoiTransaction</span> (<span class="propType">OriginalPOITransaction</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">reversedAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">saleData</span> (<span class="propType">SaleData</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">DisplayRequest {</span>
<div><span class="propName ">displayOutput</span> (<span class="propType">Array[DisplayOutput]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InputRequest {</span>
<div><span class="propName ">displayOutput</span> (<span class="propType">DisplayOutput</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">inputData</span> (<span class="propType">InputData</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">AbortRequest {</span>
<div><span class="propName ">abortReason</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">messageReference</span> (<span class="propType">MessageReference</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">TransactionStatusRequest
{</span>
<div><span class="propName ">messageReference</span> (<span class="propType">MessageReference</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">receiptReprintFlag</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">documentQualifier</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PrintRequest {</span>
<div><span class="propName ">printOutput</span> (<span class="propType">PrintOutput</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">EventNotification {</span>
<div><span class="propName ">eventDetails</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">eventToNotify</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">timeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">SecurityTrailer {</span>
<div><span class="propName required">adyenCryptoVersion</span> (<span class="propType">integer</span>),</div>
<div><span class="propName required">keyIdentifier</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">keyVersion</span> (<span class="propType">integer</span>),</div>
<div><span class="propName required">nonce</span> (<span class="propType">string</span>),</div>
<div><span class="propName required">hmac</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">MessageHeader {</span>
<div><span class="propName ">protocolVersion</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">messageClass</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['service', 'device', 'event']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"service", "device", "event"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['abort', 'admin', 'balanceInquiry', 'batch',
'cardAcquisition', 'cardReaderAPDU', 'cardReaderInit', 'cardReaderPowerOff', 'diagnosis', 'display', 'enableService', 'event', 'getTotals', 'input', 'inputUpdate', 'login', 'logout', 'loyalty', 'payment', 'pIN', 'print',
'reconciliation', 'reversal', 'sound', 'storedValue', 'transactionStatus', 'transmit']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"abort", "admin", "balanceInquiry", "batch", "cardAcquisition", "cardReaderAPDU", "cardReaderInit", "cardReaderPowerOff", "diagnosis", "display", "enableService", "event", "getTotals", "input", "inputUpdate",
"login", "logout", "loyalty", "payment", "pIN", "print", "reconciliation", "reversal", "sound", "storedValue", "transactionStatus", "transmit"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">messageType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['request', 'response', 'notification']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"request", "response", "notification"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">saleid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">serviceid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">poiid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">deviceid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PaymentRequest {</span>
<div><span class="propName ">paymentData</span> (<span class="propType">PaymentData</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">saleData</span> (<span class="propType">SaleData</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">paymentTransaction</span> (<span class="propType">PaymentTransaction</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">OriginalPOITransaction {</span>
<div><span class="propName ">poiTransactionid</span> (<span class="propType">TransactionId</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">SaleData {</span>
<div><span class="propName ">saleToAcquirerData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">tokenRequestedType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['transaction', 'customer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"transaction", "customer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">saleTransactionid</span> (<span class="propType">TransactionId</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">DisplayOutput {</span>
<div><span class="propWrap"><span class="propName ">device</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['cashierDisplay', 'customerDisplay', 'cashierInput',
'customerInput']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"cashierDisplay", "customerDisplay", "cashierInput", "customerInput"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">infoQualify</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['status', 'error', 'display', 'sound', 'input',
'pOIReplication', 'customerAssistance', 'receipt', 'document', 'voucher']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"status", "error", "display", "sound", "input", "pOIReplication", "customerAssistance", "receipt", "document", "voucher"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">outputContent</span> (<span class="propType">OutputContent</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">menuEntry</span> (<span class="propType">Array[MenuEntry]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">InputData {</span>
<div><span class="propWrap"><span class="propName ">device</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['cashierDisplay', 'customerDisplay', 'cashierInput',
'customerInput']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"cashierDisplay", "customerDisplay", "cashierInput", "customerInput"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">infoQualify</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['status', 'error', 'display', 'sound', 'input',
'pOIReplication', 'customerAssistance', 'receipt', 'document', 'voucher']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"status", "error", "display", "sound", "input", "pOIReplication", "customerAssistance", "receipt", "document", "voucher"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">inputCommand</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['getAnyKey', 'getConfirmation', 'siteManager',
'textString', 'digitString', 'decimalString', 'getFunctionKey', 'getMenuEntry', 'password']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"getAnyKey", "getConfirmation", "siteManager", "textString", "digitString", "decimalString", "getFunctionKey", "getMenuEntry", "password"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">maxInputTime</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">minLength</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">maxLength</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">defaultInputString</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">stringMask</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">maskCharactersFlag</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">maxDecimalLength</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">MessageReference {</span>
<div><span class="propWrap"><span class="propName ">messageCategory</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['abort', 'admin', 'balanceInquiry', 'batch',
'cardAcquisition', 'cardReaderAPDU', 'cardReaderInit', 'cardReaderPowerOff', 'diagnosis', 'display', 'enableService', 'event', 'getTotals', 'input', 'inputUpdate', 'login', 'logout', 'loyalty', 'payment', 'pIN', 'print',
'reconciliation', 'reversal', 'sound', 'storedValue', 'transactionStatus', 'transmit']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"abort", "admin", "balanceInquiry", "batch", "cardAcquisition", "cardReaderAPDU", "cardReaderInit", "cardReaderPowerOff", "diagnosis", "display", "enableService", "event", "getTotals", "input", "inputUpdate",
"login", "logout", "loyalty", "payment", "pIN", "print", "reconciliation", "reversal", "sound", "storedValue", "transactionStatus", "transmit"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">saleid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">serviceid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PrintOutput {</span>
<div><span class="propName ">outputContent</span> (<span class="propType">OutputContent</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">documentQualifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['saleReceipt', 'cashierReceipt',
'customerReceipt', 'document', 'voucher', 'journal']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"saleReceipt", "cashierReceipt", "customerReceipt", "document", "voucher", "journal"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">responseMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['notRequired', 'immediate', 'printEnd',
'soundEnd']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"notRequired", "immediate", "printEnd", "soundEnd"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">integratedPrintFlag</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PaymentData {</span>
<div><span class="propName ">paymentInstrumentData</span> (<span class="propType">PaymentInstrumentData</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">paymentType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['normal', 'refund', 'oneTimeReservation',
'firstReservation', 'updateReservation', 'completion', 'cashAdvance', 'cashDeposit', 'recurring', 'instalment', 'issuerInstalment', 'paidOut']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"normal", "refund", "oneTimeReservation", "firstReservation", "updateReservation", "completion", "cashAdvance", "cashDeposit", "recurring", "instalment", "issuerInstalment", "paidOut"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">splitPaymentFlag</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PaymentTransaction {</span>
<div><span class="propName ">amountsReq</span> (<span class="propType">AmountsReq</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">transactionConditions</span> (<span class="propType">TransactionConditions</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">TransactionId
{</span>
<div><span class="propName ">transactionid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">timeStamp</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">OutputContent {</span>
<div><span class="propName ">outputxhtml</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName ">outputFormat</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['messageRef', 'text', 'xHTML', 'barCode']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"messageRef", "text", "xHTML", "barCode"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">predefinedContent</span> (<span class="propType">PredefinedContent</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">outputText</span> (<span class="propType">Array[OutputText]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">MenuEntry {</span>
<div><span class="propWrap"><span class="propName ">menuEntryTag</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['selectable', 'nonSelectable', 'subMenu',
'nonSelectableSubMenu']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"selectable", "nonSelectable", "subMenu", "nonSelectableSubMenu"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">outputFormat</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['messageRef', 'text', 'xHTML', 'barCode']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"messageRef", "text", "xHTML", "barCode"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">outputText</span> (<span class="propType">Array[OutputText]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PaymentInstrumentData {</span>
<div><span class="propWrap"><span class="propName ">paymentInstrumentType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['card', 'check', 'mobile',
'storedValue', 'cash']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "check", "mobile", "storedValue", "cash"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">AmountsReq {</span>
<div><span class="propName ">currency</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">requestedAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">paidAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">TransactionConditions {</span>
<div><span class="propName ">forceEntryMode</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PredefinedContent {</span>
<div><span class="propName ">referenceid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">OutputText {</span>
<div><span class="propWrap"><span class="propName ">color</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['white', 'black', 'red', 'green', 'blue', 'yellow',
'magenta', 'cyan']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"white", "black", "red", "green", "blue", "yellow", "magenta", "cyan"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">characterWidth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['singleWidth', 'doubleWidth']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"singleWidth", "doubleWidth"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">characterHeight</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['singleHeight', 'doubleHeight',
'halfHeight']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"singleHeight", "doubleHeight", "halfHeight"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">characterStyle</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['normal', 'bold', 'italic', 'underline']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"normal", "bold", "italic", "underline"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">alignment</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['left', 'right', 'centred', 'justified']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"left", "right", "centred", "justified"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">endOfLineFlag</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName ">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"saleTopoiRequest": {
"diagnosisRequest": {
"hostDiagnosisFlag": true
},
"reversalRequest": {
"reversalReason": "string",
"originalpoiTransaction": {
"poiTransactionid": {
"transactionid": "string",
"timeStamp": "string"
}
},
"reversedAmount": 0,
"saleData": {
"saleToAcquirerData": "string",
"tokenRequestedType": "transaction",
"saleTransactionid": {
"transactionid": "string",
"timeStamp": "string"
}
}
},
"displayRequest": {
"displayOutput": [
{
"device": "cashierDisplay",
"infoQualify": "status",
"outputContent": {
"outputxhtml": "string",
"outputFormat": "messageRef",
"predefinedContent": {
"referenceid": "string"
},
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
},
"menuEntry": [
{
"menuEntryTag": "selectable",
"outputFormat": "messageRef",
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
}
]
}
]
},
"inputRequest": {
"displayOutput": {
"device": "cashierDisplay",
"infoQualify": "status",
"outputContent": {
"outputxhtml": "string",
"outputFormat": "messageRef",
"predefinedContent": {
"referenceid": "string"
},
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
},
"menuEntry": [
{
"menuEntryTag": "selectable",
"outputFormat": "messageRef",
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
}
]
},
"inputData": {
"device": "cashierDisplay",
"infoQualify": "status",
"inputCommand": "getAnyKey",
"maxInputTime": 0,
"minLength": 0,
"maxLength": 0,
"defaultInputString": "string",
"stringMask": "string",
"maskCharactersFlag": true,
"maxDecimalLength": 0
}
},
"abortRequest": {
"abortReason": "string",
"messageReference": {
"messageCategory": "abort",
"saleid": "string",
"serviceid": "string"
}
},
"transactionStatusRequest": {
"messageReference": {
"messageCategory": "abort",
"saleid": "string",
"serviceid": "string"
},
"receiptReprintFlag": true,
"documentQualifier": [
"string"
]
},
"printRequest": {
"printOutput": {
"outputContent": {
"outputxhtml": "string",
"outputFormat": "messageRef",
"predefinedContent": {
"referenceid": "string"
},
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
},
"documentQualifier": "saleReceipt",
"responseMode": "notRequired",
"integratedPrintFlag": true
}
},
"eventNotification": {
"eventDetails": "string",
"eventToNotify": "string",
"timeStamp": "string"
},
"securityTrailer": {
"adyenCryptoVersion": 0,
"keyIdentifier": "string",
"keyVersion": 0,
"nonce": "string",
"hmac": "string"
},
"nexoBlob": {},
"messageHeader": {
"protocolVersion": "string",
"messageClass": "service",
"messageCategory": "abort",
"messageType": "request",
"saleid": "string",
"serviceid": "string",
"poiid": "string",
"deviceid": "string"
},
"paymentRequest": {
"paymentData": {
"paymentInstrumentData": {
"paymentInstrumentType": "card"
},
"paymentType": "normal",
"splitPaymentFlag": true
},
"saleData": {
"saleToAcquirerData": "string",
"tokenRequestedType": "transaction",
"saleTransactionid": {
"transactionid": "string",
"timeStamp": "string"
}
},
"paymentTransaction": {
"amountsReq": {
"currency": "string",
"requestedAmount": 0,
"tipAmount": 0,
"paidAmount": 0
},
"transactionConditions": {
"forceEntryMode": [
"string"
]
}
}
}
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.35314310212394506">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.35314310212394506"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8001425634581196" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8001425634581196">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The card balance request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CardInfoRequest {</span>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.8180652709603407">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.8180652709603407" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.32449299359129036">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.32449299359129036"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7831302418916981" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7831302418916981">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The card balance request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CardBalanceOnDeviceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName ">manualCardEntry</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the device will prompt for manual card entry instead of swipe/tap (if supported by the device/gateway)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"manualCardEntry": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtoken0.057703533688661324">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.057703533688661324" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The card token.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.8782844310974633">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8782844310974633"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9861192985639118" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9861192985639118">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The card balance request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CardBalanceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.130564202158594">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.130564202158594"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8674205296468833" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8674205296468833">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The card balance request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CardBalanceWithCardDataRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code"><label for="mincludeExtendedData0.09377984951096163">includeExtendedData</label></td>
<td>
<select class="parameter " name="includeExtendedData" id="mincludeExtendedData0.09377984951096163">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>[optional] true to include extended device data (for diagnostics or troubleshooting); otherwise false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">202</td>
<td class="markdown">
<p>Accepted</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GetDeviceListResponse {</span>
<div><span class="propName ">devices</span> (<span class="propType">Array[DeviceInfo]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The devices</p>
</span></div><span class="strong">}</span><br><span class="strong">DeviceInfo {</span>
<div><span class="propName required">deviceGuid</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device GUID</p>
</span>,</div>
<div><span class="propName required">handlerId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device handler ID</p>
</span>,</div>
<div><span class="propName required">deviceNumber</span> (<span class="propType">integer</span>): <span class="propDesc markdown">
<p>The device number</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">handlerStatus</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device handler status</p>
</span> = <span class="propVals">['none', 'created', 'initializing', 'initialized', 'shuttingDown', 'shutdown', 'failed']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"none", "created", "initializing", "initialized", "shuttingDown", "shutdown", "failed"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName required">deviceStatus</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device status</p>
</span> = <span class="propVals">['unknown', 'available', 'notAvailable', 'updating', 'failed']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "available", "notAvailable", "updating", "failed"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">statusMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The status message (if any)</p>
</span>,</div>
<div><span class="propName required">handler</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device handler name</p>
</span>,</div>
<div><span class="propName ">manufacturer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device manufacturer</p>
</span>,</div>
<div><span class="propName ">product</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device product</p>
</span>,</div>
<div><span class="propName required">description</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device "friendly" description (suitable for display when selecting amongst multiple devices)</p>
</span>,</div>
<div><span class="propName required">deviceType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The device type</p>
</span>,</div>
<div><span class="propName required">devicePath</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Gets or sets the device path.</p>
</span>,</div>
<div><span class="propName required">serialNumber</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The serial number</p>
</span>,</div>
<div><span class="propName required">serialNumber2</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The serial number 2</p>
</span>,</div>
<div><span class="propName ">extendedData</span> (<span class="propType">Array[DeviceInfoExtendedDataItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The extended data, if any. This is an optional collection of data useful for diagnostics or troubleshooting</p>
</span></div><span class="strong">}</span><br><span class="strong">DeviceInfoExtendedDataItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The data item key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The data item value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"devices": [
{
"deviceGuid": "00000000-0000-0000-0000-000000000000",
"handlerId": "string",
"deviceNumber": 0,
"handlerStatus": "none",
"deviceStatus": "unknown",
"statusMessage": "string",
"handler": "string",
"manufacturer": "string",
"product": "string",
"description": "string",
"deviceType": "string",
"devicePath": "string",
"serialNumber": "string",
"serialNumber2": "string",
"extendedData": [
{
"key": "string",
"value": "string"
}
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.575548658122558">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.575548658122558" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The device unique identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code"><label for="mincludeExtendedData0.9538165020474769">includeExtendedData</label></td>
<td>
<select class="parameter " name="includeExtendedData" id="mincludeExtendedData0.9538165020474769">
<option selected="" value=""></option>
<option value="true"> true </option>
<option value="false"> false </option>
</select>
</td>
<td class="markdown">
<p>[optional] true to include extended device data (for diagnostics or troubleshooting); otherwise false.</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.3892656314633465">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.3892656314633465" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The device unique identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.07168803333766971">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.07168803333766971" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The device unique identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mlaneState0.21911257798354877">laneState</label></td>
<td>
<select class="parameter required " name="laneState" id="mlaneState0.21911257798354877">
<option value="open"> open </option>
<option value="closed"> closed </option>
</select>
</td>
<td class="markdown">
<p><strong>The lane state (e.g. open/closed).</strong></p>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.5794777296297695">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.5794777296297695" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The device unique identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">503</td>
<td class="markdown">
<p>ServiceUnavailable</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HealthDetailResponse {</span>
<div><span class="propName required">name</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay product name</p>
</span>,</div>
<div><span class="propName required">version</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay product version</p>
</span>,</div>
<div><span class="propName required">isHealthy</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the rGuest Pay Agent is healthy (true only if all the monitored service groups are healthy)</p>
</span>,</div>
<div><span class="propName required">handlerGroups</span> (<span class="propType">Array[RegisteredHandlerGroupInfo]</span>): <span class="propDesc markdown">
<p>The registered handler groups for the rGuest Pay Agent</p>
</span>,</div>
<div><span class="propName required">serviceGroups</span> (<span class="propType">Array[MonitoredServiceGroupInfo]</span>): <span class="propDesc markdown">
<p>The monitored service groups for the rGuest Pay Agent</p>
</span></div><span class="strong">}</span><br><span class="strong">RegisteredHandlerGroupInfo {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The handler group identifier</p>
</span>,</div>
<div><span class="propName required">version</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The handler group version</p>
</span>,</div>
<div><span class="propName required">handlers</span> (<span class="propType">Array[RegisteredHandlerInfo]</span>): <span class="propDesc markdown">
<p>The installed handlers for the handler group</p>
</span></div><span class="strong">}</span><br><span class="strong">MonitoredServiceGroupInfo {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The service group identifier</p>
</span>,</div>
<div><span class="propName required">isHealthy</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the service group is healthy (true only if none of the monitored services are not available)</p>
</span>,</div>
<div><span class="propName required">services</span> (<span class="propType">Array[MonitoredServiceInfo]</span>): <span class="propDesc markdown">
<p>The monitored services for the service group</p>
</span></div><span class="strong">}</span><br><span class="strong">RegisteredHandlerInfo {</span>
<div><span class="propWrap"><span class="propName required">type</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The registered handler type</p>
</span> = <span class="propVals">['device', 'gateway']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"device", "gateway"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">MonitoredServiceInfo {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The service identifier</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">status</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The service status</p>
</span> = <span class="propVals">['unknown', 'available', 'notAvailable']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "available", "notAvailable"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"name": "string",
"version": "string",
"isHealthy": true,
"handlerGroups": [
{
"id": "string",
"version": "string",
"handlers": [
{
"type": "device"
}
]
}
],
"serviceGroups": [
{
"id": "string",
"isHealthy": true,
"services": [
{
"id": "string",
"status": "unknown"
}
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.8427555808301606">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.8427555808301606" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">202</td>
<td class="markdown">
<p>Accepted</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.47158310801619985">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.47158310801619985" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.3810402237951973">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.3810402237951973"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6694771955078842" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6694771955078842">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt card capture request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PromptCardCaptureRequest {</span>
<div><span class="propName ">amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The amount</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"amount": 0,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.8417070057587275">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.8417070057587275" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">202</td>
<td class="markdown">
<p>Accepted</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.09998999650520979">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.09998999650520979" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.20704484364023767">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.20704484364023767"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2876036577622725" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2876036577622725">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt tip amount request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PromptTipAmountRequest {</span>
<div><span class="propName ">amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The subtotal amount to prompt for tip</p>
</span>,</div>
<div><span class="propName ">tipPromptData</span> (<span class="propType">TipPromptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip prompt data for this request (e.g. tip seed, tip presets)</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used</p>
</span></div><span class="strong">}</span><br><span class="strong">TipPromptData {</span>
<div><span class="propName ">tipSeedAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>If specified, this amount is "seeded" as the suggested tip amount on the device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">tipPresetValueType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Specifies the tip preset type to be used, if available, on the device</p>
</span> = <span class="propVals">['none', 'amount', 'percent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"none", "amount", "percent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">tipPreset1</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first tip preset value</p>
</span>,</div>
<div><span class="propName ">tipPreset2</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second tip preset value</p>
</span>,</div>
<div><span class="propName ">tipPreset3</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The third tip preset value</p>
</span>,</div>
<div><span class="propName ">tipPreset4</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The fourth tip preset value</p>
</span>,</div>
<div><span class="propName ">tipBasisAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tip Basis Amount. If the value is set, tip amount calculation will be based on this value.</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"amount": 0,
"tipPromptData": {
"tipSeedAmount": 0,
"tipPresetValueType": "none",
"tipPreset1": 0,
"tipPreset2": 0,
"tipPreset3": 0,
"tipPreset4": 0,
"tipBasisAmount": 0
},
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.8990310727083961">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.8990310727083961" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">202</td>
<td class="markdown">
<p>Accepted</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.4650984140672658">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.4650984140672658" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.75898886229113">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.75898886229113"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5233520539437824" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5233520539437824">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt for signature capture request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PromptSignatureCaptureRequest {</span>
<div><span class="propName ">amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount, including tip, to show on the signature capture screen</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"amount": 0,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.4959086481677146">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.4959086481677146" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.7393249564967537">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7393249564967537"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.11149673017307782" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.11149673017307782">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt for selection request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SelectionFormRequest {</span>
<div><span class="propWrap"><span class="propName required">formType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Gets or sets the type of selection form</p>
</span> = <span class="propVals">['multiButtonTextArea', 'multiButton', 'yesNoTextArea']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"multiButtonTextArea", "multiButton", "yesNoTextArea"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">header</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the header control on the form, if the form has one. For FormType "MultiOption", this sets the value in the single line prompt field on the form</p>
</span>,</div>
<div><span class="propName ">subHeader</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the sub header control on the form, if the form has one. Ignored if FormType is "MultiOption"</p>
</span>,</div>
<div><span class="propName ">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the multiline text area control, if the form has one. Ignored if FormType is "MultiOption"</p>
</span>,</div>
<div><span class="propName ">buttons</span> (<span class="propType">Array[SelectionFormButton]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A collection of selection form buttons to display on the selection form. Ignored if FormType is "YesNoTextArea"</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">afterUserInputAction</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies the action the device should take after the user interacts with the device; if not specified, defaults to processing</p>
</span> = <span class="propVals">['processing', 'idle', 'none']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"processing", "idle", "none"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">SelectionFormButton {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The button's selection identifier; when this button is selected, this id is returned as the selected button id</p>
</span>,</div>
<div><span class="propName required">text</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The button text to display on the button; when this button is selected, this text is returned as the selected button text</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"formType": "multiButtonTextArea",
"header": "string",
"subHeader": "string",
"text": "string",
"buttons": [
{
"id": "string",
"text": "string"
}
],
"afterUserInputAction": "processing"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.753513315796398">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.753513315796398" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.3123972490817475">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.3123972490817475"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.1344915566100937" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.1344915566100937">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt for message request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MessageFormRequest {</span>
<div><span class="propName ">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The message text to display on the message form. Defaults to "Processing, please wait..." if not specified</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"text": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.5421126959250979">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.5421126959250979" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.0323395073172803">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.0323395073172803"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9075368725280011" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9075368725280011">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt for signature request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SignatureFormRequest {</span>
<div><span class="propWrap"><span class="propName required">formType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Gets or sets the type of signature form</p>
</span> = <span class="propVals">['standard', 'textArea']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"standard", "textArea"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">header</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the header control on the form, if the form has one; if not specified, the device will display a default signature prompt</p>
</span>,</div>
<div><span class="propName ">subHeader</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the sub header control on the form, if the form has one. Ignored if formType is "Standard"</p>
</span>,</div>
<div><span class="propName ">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the multiline text area control, if the form has one. Ignored if formType is "Standard"</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">afterUserInputAction</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies the action the device should take after the user interacts with the device; if not specified, defaults to idle</p>
</span> = <span class="propVals">['processing', 'idle', 'none']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"processing", "idle", "none"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"formType": "standard",
"header": "string",
"subHeader": "string",
"text": "string",
"afterUserInputAction": "processing"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.17206748016276974">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.17206748016276974" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.23864975834567104">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.23864975834567104"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9040193030453272" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9040193030453272">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt for custom form request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CustomFormRequest {</span>
<div><span class="propName required">formId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Gets or sets the custom form id</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">formType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Gets or sets the type of custom form</p>
</span> = <span class="propVals">['multiButtonTextArea', 'multiButton', 'yesNoTextArea']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"multiButtonTextArea", "multiButton", "yesNoTextArea"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">header</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the header control on the form, if the form has one. For FormType "MultiOption", this sets the value in the single line prompt field on the form</p>
</span>,</div>
<div><span class="propName ">subHeader</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the sub header control on the form, if the form has one. Ignored if FormType is "MultiOption"</p>
</span>,</div>
<div><span class="propName ">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Sets text on the multiline text area control, if the form has one. Ignored if FormType is "MultiOption"</p>
</span>,</div>
<div><span class="propName ">buttons</span> (<span class="propType">Array[CustomFormButton]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A collection of custom form buttons to display on the custom form. Ignored if FormType is "YesNoTextArea"</p>
</span>,</div>
<div><span class="propName ">labels</span> (<span class="propType">Array[CustomFormLabel]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A collection of custom form labels to display on the custom form.</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">afterUserInputAction</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies the action the device should take after the user interacts with the device; if not specified, defaults to processing</p>
</span> = <span class="propVals">['processing', 'idle', 'none']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"processing", "idle", "none"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span><br><span class="strong">CustomFormButton {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The button's selection identifier; when this button is selected, this id is returned as the selected button id</p>
</span>,</div>
<div><span class="propName required">text</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The button text to display on the button; when this button is selected, this text is returned as the selected button text</p>
</span></div><span class="strong">}</span><br><span class="strong">CustomFormLabel {</span>
<div><span class="propName ">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The label's identifier on the custom form;</p>
</span>,</div>
<div><span class="propName ">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The label text to display on the custom form;</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"formId": "string",
"formType": "multiButtonTextArea",
"header": "string",
"subHeader": "string",
"text": "string",
"buttons": [
{
"id": "string",
"text": "string"
}
],
"labels": [
{
"id": "string",
"text": "string"
}
],
"afterUserInputAction": "processing"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.19104080619933161">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.19104080619933161" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">202</td>
<td class="markdown">
<p>Accepted</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.16674255764190193">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.16674255764190193" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.6842025240225094">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6842025240225094"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9917711108162222" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9917711108162222">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The prompt for security code request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PromptSecurityCodeRequest {</span><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.563576541996869">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.563576541996869"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.33670116752023693" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.33670116752023693">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The log capture request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LogCaptureRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName ">logFilePath</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The log file path.</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"logFilePath": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.12327564658293522">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.12327564658293522"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9181062793376125" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9181062793376125">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The end of day(EOD) batch process request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">EODBatchProcessRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.036634816992110686">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.036634816992110686"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3156166848294919" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3156166848294919">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table open check request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OpenPayAtTableCheckRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">checkData</span> (<span class="propType">PayAtTableCheckData</span>): <span class="propDesc markdown">
<p>The Pay-at-Table check data</p>
</span>,</div>
<div><span class="propName ">messageData</span> (<span class="propType">PayAtTableMessageData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Pay-at-Table message data; if specified, this allows optional information to be displayed on the device when the check is brought up (actual functionality depends on specific device capability)</p>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">PayAtTableReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Pay-at-Table receipt data; if specified, this allows optional information to be displayed on the receipt when the receipt is printed (actual functionality depends on specific gateway and device capability). Note: any
text provided in receipt data should typically be in the same language as specified for the culture name of the merchant</p>
</span>,</div>
<div><span class="propName ">cultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The ISO culture name (e.g. "en-US", "en-GB", "fr-FR", "fr-CA") which must be a combination of an ISO-639 two-letter culture code associated with a language and an ISO-3166 two-letter uppercase subculture code associated
with a country or region. See <a href="https://en.wikipedia.org/wiki/ISO_639">https://en.wikipedia.org/wiki/ISO_639</a> and <a href="https://en.wikipedia.org/wiki/ISO_3166">https://en.wikipedia.org/wiki/ISO_3166</a> for
more information. Note: this culture name represents the culture (language and country/region) in which the merchant is doing business and directly affects the regional formatting for date/time values and amount values. If
not specified, the current culture of the rGuest Pay environment is assumed</p>
</span>,</div>
<div><span class="propName ">currencyCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The ISO currency code (e.g. "USD", "EUR", "GBP", "JPY") which must be an ISO-4217 three-letter alphabetic currency code. See <a href="https://en.wikipedia.org/wiki/ISO_4217">https://en.wikipedia.org/wiki/ISO_4217</a> for
more information. Note: this currency code represents the currency in which the merchant is doing business. If not specified, the currency code for the region of the current culture of the rGuest Pay environment is assumed
</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableCheckData {</span>
<div><span class="propName required">checkNumber</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client check number</p>
</span>,</div>
<div><span class="propName required">checkOpenDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client check open date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">locationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client location id (such as as profit center id or sales outlet id)</p>
</span>,</div>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName required">clerkId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName ">clerkCardNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk card number or employee card number</p>
</span>,</div>
<div><span class="propName ">tableNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client table number</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the check (inclusive of tax amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, of the check (this amount is included in the total amount)</p>
</span>,</div>
<div><span class="propName required">unpaidAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The current unpaid amount on the check (this is the remaining amount due on the check)</p>
</span>,</div>
<div><span class="propName ">tipBasisAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tip Basis Amount. If the value is set, tip amount calculation will be based on this value</p>
</span>,</div>
<div><span class="propName ">accessFilters</span> (<span class="propType">PayAtTableAccessFilters</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The access filter(s), if any. This allows optional information that can be used to classify the check(s)</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableMessageData {</span>
<div><span class="propName ">messageLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The message text for the first display line on the payment device (this allows optional information to be displayed on the device when the check is brought up; actual functionality depends on specific device capability)
</p>
</span>,</div>
<div><span class="propName ">messageLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The message text for the second display line on the payment device (this allows optional information to be displayed on the device when the check is brought up; actual functionality depends on specific device capability)
</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableReceiptData {</span>
<div><span class="propName ">headerText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The optional receipt header text that should contain the merchant's business name, business address, and other relevant information to be printed at the top of the receipt (however, actual functionality depends on
specific gateway and device capability including the length of lines and any necessary wrapping of long text across lines). Note: this text should typically be in the same language as specified for the culture of the
merchant. Each text line should be encoded as UTF-8 and should not contain any embedded line breaks. For more information, see section 7 of
<a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">checkItemsData</span> (<span class="propType">Array[CheckItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the Pay-at-Table check items (if any).</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableAccessFilters {</span>
<div><span class="propName ">clerks</span> (<span class="propType">Array[PayAtTableClerk]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The additional clerk(s) can be mapped to the check</p>
</span></div><span class="strong">}</span><br><span class="strong">CheckItem {</span>
<div><span class="propName ">amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The amount of the ordered item</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The description</p>
</span>,</div>
<div><span class="propName ">quantity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The quantity of the item</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableClerk {</span>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName ">clerkCardNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk card number or employee card number</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"checkData": {
"checkNumber": "string",
"checkOpenDate": "2024-09-02T20:03:47.984Z",
"locationId": "string",
"registerId": "string",
"clerkId": "string",
"clerkCardNumber": "string",
"tableNumber": "string",
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0,
"tipBasisAmount": 0,
"accessFilters": {
"clerks": [
{
"clerkId": "string",
"clerkCardNumber": "string"
}
]
}
},
"messageData": {
"messageLine1": "string",
"messageLine2": "string"
},
"receiptData": {
"headerText": [
"string"
],
"checkItemsData": [
{
"amount": 0,
"description": "string",
"quantity": 0
}
]
},
"cultureName": "string",
"currencyCode": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcheckId0.5036733705539658">checkId</label></td>
<td>
<input class="parameter required" minlength="1" name="checkId" placeholder="(required)" id="mcheckId0.5036733705539658" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table check identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.3158287087780174">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.3158287087780174"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8330905950257128" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8330905950257128">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table update check request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdatePayAtTableCheckRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">checkData</span> (<span class="propType">PayAtTableCheckData</span>): <span class="propDesc markdown">
<p>The Pay-at-Table check data</p>
</span>,</div>
<div><span class="propName ">messageData</span> (<span class="propType">PayAtTableMessageData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Pay-at-Table message data; if specified, this allows optional information to be displayed on the device when the check is brought up (actual functionality depends on specific device capability)</p>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">PayAtTableReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Pay-at-Table receipt data; if specified, this allows optional information to be displayed on the receipt when the receipt is printed (actual functionality depends on specific gateway and device capability). Note: any
text provided in receipt data should typically be in the same language as specified for the culture name of the merchant</p>
</span>,</div>
<div><span class="propName ">cultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The ISO culture name (e.g. "en-US", "en-GB", "fr-FR", "fr-CA") which must be a combination of an ISO-639 two-letter culture code associated with a language and an ISO-3166 two-letter uppercase subculture code associated
with a country or region. See <a href="https://en.wikipedia.org/wiki/ISO_639">https://en.wikipedia.org/wiki/ISO_639</a> and <a href="https://en.wikipedia.org/wiki/ISO_3166">https://en.wikipedia.org/wiki/ISO_3166</a> for
more information. Note: this culture name represents the culture (language and country/region) in which the merchant is doing business and directly affects the regional formatting for date/time values and amount values. If
not specified, the current culture of the rGuest Pay environment is assumed</p>
</span>,</div>
<div><span class="propName ">currencyCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The ISO currency code (e.g. "USD", "EUR", "GBP", "JPY") which must be an ISO-4217 three-letter alphabetic currency code. See <a href="https://en.wikipedia.org/wiki/ISO_4217">https://en.wikipedia.org/wiki/ISO_4217</a> for
more information. Note: this currency code represents the currency in which the merchant is doing business. If not specified, the currency code for the region of the current culture of the rGuest Pay environment is assumed
</p>
</span>,</div>
<div><span class="propName ">inquiryRequest</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Inquiry Request</p>
</span>,</div>
<div><span class="propName ">inquiryRetryCount</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Inquiry RetryCount</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableCheckData {</span>
<div><span class="propName required">checkNumber</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client check number</p>
</span>,</div>
<div><span class="propName required">checkOpenDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client check open date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">locationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client location id (such as as profit center id or sales outlet id)</p>
</span>,</div>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName required">clerkId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName ">clerkCardNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk card number or employee card number</p>
</span>,</div>
<div><span class="propName ">tableNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client table number</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the check (inclusive of tax amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, of the check (this amount is included in the total amount)</p>
</span>,</div>
<div><span class="propName required">unpaidAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The current unpaid amount on the check (this is the remaining amount due on the check)</p>
</span>,</div>
<div><span class="propName ">tipBasisAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tip Basis Amount. If the value is set, tip amount calculation will be based on this value</p>
</span>,</div>
<div><span class="propName ">accessFilters</span> (<span class="propType">PayAtTableAccessFilters</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The access filter(s), if any. This allows optional information that can be used to classify the check(s)</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableMessageData {</span>
<div><span class="propName ">messageLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The message text for the first display line on the payment device (this allows optional information to be displayed on the device when the check is brought up; actual functionality depends on specific device capability)
</p>
</span>,</div>
<div><span class="propName ">messageLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The message text for the second display line on the payment device (this allows optional information to be displayed on the device when the check is brought up; actual functionality depends on specific device capability)
</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableReceiptData {</span>
<div><span class="propName ">headerText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The optional receipt header text that should contain the merchant's business name, business address, and other relevant information to be printed at the top of the receipt (however, actual functionality depends on
specific gateway and device capability including the length of lines and any necessary wrapping of long text across lines). Note: this text should typically be in the same language as specified for the culture of the
merchant. Each text line should be encoded as UTF-8 and should not contain any embedded line breaks. For more information, see section 7 of
<a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">checkItemsData</span> (<span class="propType">Array[CheckItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Gets or sets the Pay-at-Table check items (if any).</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableAccessFilters {</span>
<div><span class="propName ">clerks</span> (<span class="propType">Array[PayAtTableClerk]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The additional clerk(s) can be mapped to the check</p>
</span></div><span class="strong">}</span><br><span class="strong">CheckItem {</span>
<div><span class="propName ">amount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The amount of the ordered item</p>
</span>,</div>
<div><span class="propName ">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The description</p>
</span>,</div>
<div><span class="propName ">quantity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The quantity of the item</p>
</span></div><span class="strong">}</span><br><span class="strong">PayAtTableClerk {</span>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName ">clerkCardNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk card number or employee card number</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"checkData": {
"checkNumber": "string",
"checkOpenDate": "2024-09-02T20:03:47.995Z",
"locationId": "string",
"registerId": "string",
"clerkId": "string",
"clerkCardNumber": "string",
"tableNumber": "string",
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0,
"tipBasisAmount": 0,
"accessFilters": {
"clerks": [
{
"clerkId": "string",
"clerkCardNumber": "string"
}
]
}
},
"messageData": {
"messageLine1": "string",
"messageLine2": "string"
},
"receiptData": {
"headerText": [
"string"
],
"checkItemsData": [
{
"amount": 0,
"description": "string",
"quantity": 0
}
]
},
"cultureName": "string",
"currencyCode": "string",
"inquiryRequest": "string",
"inquiryRetryCount": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.9186656986431299">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9186656986431299"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5779346429744643" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5779346429744643">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table query checks request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">QueryPayAtTableChecksRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName ">includeClosedChecks</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if closed checks should be included in the response with open checks (default if not specified is to only include open checks)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"includeClosedChecks": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcheckId0.7882985173804471">checkId</label></td>
<td>
<input class="parameter required" minlength="1" name="checkId" placeholder="(required)" id="mcheckId0.7882985173804471" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table check identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.8721313837852196">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8721313837852196"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.17165561749861658" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.17165561749861658">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table query check request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">QueryPayAtTableCheckRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcheckId0.16638963218601632">checkId</label></td>
<td>
<input class="parameter required" minlength="1" name="checkId" placeholder="(required)" id="mcheckId0.16638963218601632" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table check identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.6872983522767482">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6872983522767482"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9952888044576285" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9952888044576285">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table query check payments request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">QueryPayAtTableCheckPaymentsRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcheckId0.7516893104767972">checkId</label></td>
<td>
<input class="parameter required" minlength="1" name="checkId" placeholder="(required)" id="mcheckId0.7516893104767972" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table check identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.47934349601749493">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.47934349601749493"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.25222697086814105" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.25222697086814105">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table acknowledge check payments request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AcknowledgePayAtTableCheckPaymentsRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">paymentIds</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The Pay-at-Table payment identifiers.</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the check (inclusive of tax amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, of the check (this amount is included in the total amount)</p>
</span>,</div>
<div><span class="propName required">unpaidAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The remaining unpaid amount on the check that reflects these acknowledged payments</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"paymentIds": [
"string"
],
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcheckId0.5368616131730115">checkId</label></td>
<td>
<input class="parameter required" minlength="1" name="checkId" placeholder="(required)" id="mcheckId0.5368616131730115" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table check identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.6195824843222586">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.6195824843222586"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.230187553055768" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.230187553055768">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table add payment request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UpdatePayAtTableCheckPaymentRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">transactionId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The Pay-at-Table payment identifier to be associated with the check</p>
</span>,</div>
<div><span class="propName required">transactionType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The Pay-at-Table payment type being applied</p>
</span>,</div>
<div><span class="propName required">newTransactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The new transaction amount of the check (inclusive of tax amount)</p>
</span>,</div>
<div><span class="propName required">paymentAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The amount of the payment to be applied on the check</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"transactionId": "string",
"transactionType": "string",
"newTransactionAmount": 0,
"paymentAmount": 0
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mcheckId0.030596431011482572">checkId</label></td>
<td>
<input class="parameter required" minlength="1" name="checkId" placeholder="(required)" id="mcheckId0.030596431011482572" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table check identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.7596000699884109">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7596000699884109"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.35635166137450835" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.35635166137450835">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The Pay-at-Table close check request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ClosePayAtTableCheckRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.09369185994199847">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.09369185994199847" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.5078934225342477">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.5078934225342477"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.007641288381028399" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.007641288381028399">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The create token request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateTokenOnDeviceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used</p>
</span>,</div>
<div><span class="propName ">manualCardEntry</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the device is requested to prompt for manual card entry instead of insert/swipe/tap (if supported by the device/gateway)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"manualCardEntry": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.12773970293555093">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.12773970293555093"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.91466827717205" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.91466827717205">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The create token request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreateTokenWithCardDataRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used Not used. Added back for backward compatibility</p>
</span>,</div>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data to exchange for a token</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.024218036135097876">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.024218036135097876" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.4041014504049294">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.4041014504049294"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.6711046719542346" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.6711046719542346">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The sale request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">BeginSaleOnDeviceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a sale request</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.078Z"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.7845833788607837">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.7845833788607837" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.1251876430865373">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.1251876430865373"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.09449812798770219" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.09449812798770219">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The sale request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SaleOnDeviceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a sale request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a sale request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a sale request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">tipPromptData</span> (<span class="propType">TipPromptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>If specified, the tip prompt data for a sale request will be used to prompt the guest for a tip on the payment device. If not specified, the guest will not be prompted for a tip</p>
</span>,</div>
<div><span class="propName ">promptForSignature</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the device will prompt the guest for a signature or not (if not specified, defaults to true)</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device (if not specified, the default culture is used)</p>
</span>,</div>
<div><span class="propName ">offline</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the transaction is requested to be handled as offline (if supported by the device/gateway)</p>
</span>,</div>
<div><span class="propName ">manualCardEntry</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the device is requested to prompt for manual card entry instead of insert/swipe/tap (if supported by the device/gateway)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">TipPromptData {</span>
<div><span class="propName ">tipSeedAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>If specified, this amount is "seeded" as the suggested tip amount on the device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">tipPresetValueType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>Specifies the tip preset type to be used, if available, on the device</p>
</span> = <span class="propVals">['none', 'amount', 'percent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"none", "amount", "percent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">tipPreset1</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first tip preset value</p>
</span>,</div>
<div><span class="propName ">tipPreset2</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second tip preset value</p>
</span>,</div>
<div><span class="propName ">tipPreset3</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The third tip preset value</p>
</span>,</div>
<div><span class="propName ">tipPreset4</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The fourth tip preset value</p>
</span>,</div>
<div><span class="propName ">tipBasisAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Tip Basis Amount. If the value is set, tip amount calculation will be based on this value.</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.087Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.087Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.087Z",
"checkOutDate": "2024-09-02T20:03:48.087Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"tipPromptData": {
"tipSeedAmount": 0,
"tipPresetValueType": "none",
"tipPreset1": 0,
"tipPreset2": 0,
"tipPreset3": 0,
"tipPreset4": 0,
"tipBasisAmount": 0
},
"promptForSignature": true,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"offline": true,
"manualCardEntry": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtoken0.8072085244070333">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.8072085244070333" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The card token</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.7282260183015621">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7282260183015621"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.0776864621430331" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.0776864621430331">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The sale request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SaleRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a sale request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a sale request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a sale request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.101Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.101Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.101Z",
"checkOutDate": "2024-09-02T20:03:48.101Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.8562665318762455">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8562665318762455"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.03819887231826491" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.03819887231826491">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The sale request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SaleWithCardDataRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a sale request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a sale request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a sale request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.115Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.115Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.115Z",
"checkOutDate": "2024-09-02T20:03:48.115Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.08191309359744925">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.08191309359744925" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.14522380146233393">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.14522380146233393"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3850703223642651" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3850703223642651">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthOnDeviceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for an auth request, if applicable</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the authorization as online. An auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is based on a prior transaction id</p>
</span>,</div>
<div><span class="propName ">promptForSignature</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the device will prompt the guest for a signature or not (if not specified, defaults to true)</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used</p>
</span>,</div>
<div><span class="propName ">offline</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the transaction is requested to be handled as offline (if supported by the device/gateway)</p>
</span>,</div>
<div><span class="propName ">manualCardEntry</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the device is requested to prompt for manual card entry instead of insert/swipe/tap (if supported by the device/gateway)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.128Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.128Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.128Z",
"checkOutDate": "2024-09-02T20:03:48.128Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"promptForSignature": true,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"offline": true,
"manualCardEntry": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtoken0.9139459192792063">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.9139459192792063" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The card token</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.01302392302817501">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.01302392302817501"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4404614030034053" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4404614030034053">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for an auth request, if applicable</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the authorization as online. An auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is based on a prior transaction id</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.141Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.141Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.141Z",
"checkOutDate": "2024-09-02T20:03:48.141Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.8291537697456206">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8291537697456206"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.34737907075644125" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.34737907075644125">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthWithCardDataRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for an auth request, if applicable</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the authorization as online. An auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is based on a prior transaction id</p>
</span>,</div>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.155Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.155Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.155Z",
"checkOutDate": "2024-09-02T20:03:48.155Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.8133199895857837">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8133199895857837"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5929888920392437" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5929888920392437">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthWithTransactionStateRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for an auth request, if applicable</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is true if request uses a device or request contains encrypted credit card data)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the authorization as online. An auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is based on a prior transaction id</p>
</span>,</div>
<div><span class="propName required">transactionState</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction state returned from a previous offline transaction response</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.167Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.167Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.167Z",
"checkOutDate": "2024-09-02T20:03:48.167Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"transactionState": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtransactionId0.7022721532860561">transactionId</label></td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" id="mtransactionId0.7022721532860561" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The transaction identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.22506835715087825">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.22506835715087825"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.3517735979628591" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.3517735979628591">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth increase request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthIncreaseRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth increase request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionAuthIncreaseData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth increase request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for an auth increase request</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">transactionFollowOnData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction follow-on data, if returned from the gateway, from a prior transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionAuthIncreaseData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">incrementalTransactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The incremental amount of the authorization increase (this is the amount by which to increase the authorization)</p>
</span>,</div>
<div><span class="propName ">incrementalTaxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, of the incremental transaction amount (this amount is included in the incremental amount)</p>
</span>,</div>
<div><span class="propName required">newTransactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The new total amount of the authorization, inclusive of the incremental transaction amount</p>
</span>,</div>
<div><span class="propName ">newTaxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, of the new total authorization amount (this amount is included in the new transaction amount)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.185Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.185Z",
"referenceCode": "string",
"incrementalTransactionAmount": 0,
"incrementalTaxAmount": 0,
"newTransactionAmount": 0,
"newTaxAmount": 0
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.185Z",
"checkOutDate": "2024-09-02T20:03:48.185Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtransactionId0.8893755079979817">transactionId</label></td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" id="mtransactionId0.8893755079979817" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The transaction identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.3183072470263639">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.3183072470263639"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5322257073546033" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5322257073546033">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth decrease request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthDecreaseRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth decrease request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionAuthDecreaseData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth decrease request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for an auth decrease request</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">transactionFollowOnData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction follow-on data, if returned from the gateway, from a prior transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionAuthDecreaseData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">originalTransactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original authorization amount</p>
</span>,</div>
<div><span class="propName required">newTransactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The new total amount of the authorization (the decreased transaction amount)</p>
</span>,</div>
<div><span class="propName required">newTaxAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The tax amount, if any, of the new total authorization amount (this amount is included in the new transaction amount)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.201Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.201Z",
"referenceCode": "string",
"originalTransactionAmount": 0,
"newTransactionAmount": 0,
"newTaxAmount": 0
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.201Z",
"checkOutDate": "2024-09-02T20:03:48.201Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtransactionId0.9143407281136491">transactionId</label></td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" id="mtransactionId0.9143407281136491" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The transaction identifier.</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.787495166471768">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.787495166471768"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.9453559593998475" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.9453559593998475">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The auth reversal request.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AuthReversalRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for an auth increase request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionAuthReversalData</span>): <span class="propDesc markdown">
<p>Transaction data for an auth reversal request</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">transactionFollowOnData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction follow-on data, if returned from the gateway, from a prior transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionAuthReversalData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">originalTransactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original authorization amount</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.213Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.213Z",
"referenceCode": "string",
"originalTransactionAmount": 0
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td class="markdown">
<p>NotImplemented</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtransactionId0.751488154814618">transactionId</label></td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" id="mtransactionId0.751488154814618" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The transaction identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.7798088672759569">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7798088672759569"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4878597685887751" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4878597685887751">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The capture request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CaptureRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a capture request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a capture request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a capture request</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction state, if returned from the gateway, from a prior authorization transaction</p>
</span>,</div>
<div><span class="propName ">transactionFollowOnData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction follow-on data, if returned from the gateway, from a prior transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.227Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.227Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.227Z",
"checkOutDate": "2024-09-02T20:03:48.227Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionState": "string",
"transactionFollowOnData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtoken0.1072750146352155">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.1072750146352155" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The card token</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.5592004097842078">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.5592004097842078"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.38360243975061326" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.38360243975061326">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The force capture request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForceCaptureRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a force capture request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a force capture request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a force capture request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the force capture as offline</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.240Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.240Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.240Z",
"checkOutDate": "2024-09-02T20:03:48.240Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.2876884770598984">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.2876884770598984"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7161716266138323" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7161716266138323">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The force capture request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForceCaptureWithCardDataRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a force capture request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a force capture request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a force capture request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the force capture as offline</p>
</span>,</div>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.251Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.251Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.251Z",
"checkOutDate": "2024-09-02T20:03:48.251Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.9284114784224462">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9284114784224462"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.2569817314391869" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.2569817314391869">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The force capture request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ForceCaptureWithTransactionStateRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a force capture request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentCaptureData</span>): <span class="propDesc markdown">
<p>Transaction data for a force capture request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a force capture request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The verbal authorization code from the authorization center, if provided. If none provided, the gateway will treat the force capture as offline</p>
</span>,</div>
<div><span class="propName required">transactionState</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction state returned from a previous offline transaction response</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentCaptureData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount, if any, for this request (this amount or a tip captured on the payment device is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.264Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.265Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.265Z",
"checkOutDate": "2024-09-02T20:03:48.265Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"transactionState": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtransactionId0.15521508543099927">transactionId</label></td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" id="mtransactionId0.15521508543099927" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The transaction identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.7590904019610223">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7590904019610223"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.4555646789724108" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.4555646789724108">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The refund request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RefundRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a refund request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for a refund request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a refund request</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">transactionFollowOnData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction follow-on data, if returned from the gateway, from a prior transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.284Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.284Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.284Z",
"checkOutDate": "2024-09-02T20:03:48.284Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mdeviceGuid0.9320991300845958">deviceGuid</label></td>
<td>
<input class="parameter required" minlength="1" name="deviceGuid" placeholder="(required)" id="mdeviceGuid0.9320991300845958" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The unique identifier of the device</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.880286391527789">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.880286391527789"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7394617966196368" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7394617966196368">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The credit request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreditOnDeviceRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a credit request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for a credit request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a credit request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">promptForSignature</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the device will prompt the guest for a signature or not (if not specified, defaults to true)</p>
</span>,</div>
<div><span class="propName ">currencyCulture</span> (<span class="propType">CurrencyCulture</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Client culture to use when displaying currency amounts on a display device, if not specified, the default culture is used</p>
</span>,</div>
<div><span class="propName ">manualCardEntry</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether or not the device is requested to prompt for manual card entry instead of insert/swipe/tap (if supported by the device/gateway)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CurrencyCulture {</span>
<div><span class="propName ">currencyCultureName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency culture name (e.g. "en-US", "en-GB", "fr-FR")</p>
</span>,</div>
<div><span class="propName ">currencySymbol</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The currency symbol (e.g. "$", "£", "€"); if specified, this value overrides the currency symbol determined by current service culture</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.295Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.295Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.295Z",
"checkOutDate": "2024-09-02T20:03:48.295Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"promptForSignature": true,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"manualCardEntry": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtoken0.04332981978178685">token</label></td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" id="mtoken0.04332981978178685" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The card token</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.9020993678596019">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.9020993678596019"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7634082069287613" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7634082069287613">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The credit request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreditRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a credit request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for a credit request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a credit request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.312Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.312Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.312Z",
"checkOutDate": "2024-09-02T20:03:48.312Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.7854494488307273">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.7854494488307273"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.7953330945558654" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.7953330945558654">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The credit request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreditWithCardDataRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a credit request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for a credit request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a credit request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName required">encryptedCardData</span> (<span class="propType">EncryptedCardData</span>): <span class="propDesc markdown">
<p>The encrypted credit card data</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">EncryptedCardData {</span>
<div><span class="propName ">deviceType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The device type identifier as reported by the device, if any, e.g. ingenico, idtechkb, etc.</p>
</span>,</div>
<div><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card entry mode as reported by the device, if any, e.g. swiped, keyed, etc.</p>
</span>,</div>
<div><span class="propName ">encryptionMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption mode, e.g. onguard, tdes, etc. as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptionKeySerialNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encryption key serial number as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted card data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Th encrypted track 1 data reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack1Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 1 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data as reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">encryptedTrack2Length</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The encrypted track 2 data length reported by the device, if any</p>
</span>,</div>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name as reported by the device, if any. If only encrypted track 2 is provided, there will not be cardholder name in that track (because encrypted track 1 would be the track to contain cardholder name) and
cardholder name should be provided in this field if available. If encrypted data is provided, it is possible (depending on the device) that cardholder name is contained in the encrypted data.</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.326Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.326Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.326Z",
"checkOutDate": "2024-09-02T20:03:48.326Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mrequest0.8899006232740507">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.8899006232740507"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.5054710163660561" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.5054710163660561">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The credit request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CreditWithTransactionStateRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a credit request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionPaymentData</span>): <span class="propDesc markdown">
<p>Transaction data for a credit request</p>
</span>,</div>
<div><span class="propName ">lodgingData</span> (<span class="propType">LodgingData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Lodging data for a credit request</p>
</span>,</div>
<div><span class="propName ">billingAddress</span> (<span class="propType">AddressData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Customer billing address, if applicable</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName required">transactionState</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction state returned from a previous offline transaction response</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span>,</div>
<div><span class="propName required">transactionAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The transaction amount for this request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">taxAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tax amount, if any, for this transaction (this amount is included in the transaction amount)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The surcharge amount, if any, for this transaction (this amount is added to the transaction amount before the cardholder is charged)</p>
</span>,</div>
<div><span class="propName ">allowPartialTransactionAmount</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the client can accept partial authorizations or not (if not specified, default is true)</p>
</span></div><span class="strong">}</span><br><span class="strong">LodgingData {</span>
<div><span class="propName ">folioNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The folio number of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">guestName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The name of the guest (required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">checkInDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-in date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">checkOutDate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The check-out date for the guest in the client's time zone in ISO 8601 format (required if chargeType is other than "backOffice"). See
<a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">expectedDuration</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expected stay duration in days for the guest (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge type (default value is "lodging" if not provided)</p>
</span> = <span class="propVals">['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"lodging", "restaurant", "giftShop", "other", "backOffice"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">chargeCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The charge code (default value is "default" if not provided)</p>
</span> = <span class="propVals">['default', 'advanceDeposit', 'delayedCharge']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"default", "advanceDeposit", "delayedCharge"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">noShow</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Indicates the guest was a "no-show" (default value is false if not provided)</p>
</span>,</div>
<div><span class="propName ">roomNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The room number of the guest</p>
</span>,</div>
<div><span class="propName ">dailyRoomRate</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room rate (value must be greater than zero and is required if chargeType is other than "backOffice")</p>
</span>,</div>
<div><span class="propName ">dailyRoomTax</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The daily room tax (default value is zero if not provided)</p>
</span>,</div>
<div><span class="propName ">extraChargesTotalAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total amount of extra charges, if any</p>
</span>,</div>
<div><span class="propName ">extraChargesTypes</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The types of extra charges, if any (default value is "other" if not provided but extra charges total amount provided) = ['restaurant', 'giftShop', 'telephone', 'minibar', 'laundry', 'other']</p>
</span></div><span class="strong">}</span><br><span class="strong">AddressData {</span>
<div><span class="propName ">firstName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's first name, if any</p>
</span>,</div>
<div><span class="propName ">middleName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's middle name, if any</p>
</span>,</div>
<div><span class="propName ">lastName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The account holder's last name, if any</p>
</span>,</div>
<div><span class="propName ">addressLine1</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The first line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">addressLine2</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The second line of the street address, if any</p>
</span>,</div>
<div><span class="propName ">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The city, if any</p>
</span>,</div>
<div><span class="propName ">state</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The state or province, if any</p>
</span>,</div>
<div><span class="propName ">postalCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The zip or postal code, if any</p>
</span>,</div>
<div><span class="propName ">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3">https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3</a></p>
</span>,</div>
<div><span class="propName ">phoneNumber</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The phone number, if any</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.341Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.341Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.341Z",
"checkOutDate": "2024-09-02T20:03:48.341Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"transactionState": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">402</td>
<td class="markdown">
<p>PaymentRequired</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Parameters</h4>
<table class="fullwidth parameters">
<thead>
<tr>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter</th>
<th style="width: 310px; max-width: 310px" data-sw-translate="">Value</th>
<th style="width: 200px; max-width: 200px" data-sw-translate="">Description</th>
<th style="width: 100px; max-width: 100px" data-sw-translate="">Parameter Type</th>
<th style="width: 220px; max-width: 230px" data-sw-translate="">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required"><label for="mtransactionId0.7322213666961281">transactionId</label></td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" id="mtransactionId0.7322213666961281" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The transaction identifier</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required"><label for="mrequest0.44397225892481185">request</label></td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="request" id="mrequest0.44397225892481185"></textarea>
<div class="editor_holder"></div>
<br>
<div class="parameter-content-type">
<div><label for="pct0.8784164663406449" data-sw-translate="">Parameter content type:</label>
<select name="parameterContentType" id="pct0.8784164663406449">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The void request</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">VoidRequest {</span>
<div><span class="propName ">requestId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The request identifier, if any. This is an optional client-generated GUID that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName required">gatewayId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The gateway identifier. This indicates to rGuest Pay the gateway handler that should be used to process the request</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">industryType</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The industry type, if any. If not specified, the gateway handler will default to the merchant configuration in the gateway</p>
</span> = <span class="propVals">['retail', 'foodAndBeverage', 'lodging', 'eCommerce']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"retail", "foodAndBeverage", "lodging", "eCommerce"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">configuration</span> (<span class="propType">Array[ConfigurationItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration, if any. This may be required depending on the particular request and gateway identifier</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[TagItem]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tags, if any. This is an optional collection of client-specified tags that may be logged or stored with the request</p>
</span>,</div>
<div><span class="propName ">storedCredential</span> (<span class="propType">StoredCredentialItem</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>StoredCredential</p>
</span>,</div>
<div><span class="propName required">invoiceData</span> (<span class="propType">InvoiceData</span>): <span class="propDesc markdown">
<p>Invoice data for a void request</p>
</span>,</div>
<div><span class="propName required">transactionData</span> (<span class="propType">TransactionData</span>): <span class="propDesc markdown">
<p>Transaction data for a void request</p>
</span>,</div>
<div><span class="propName ">cardPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the card is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">cardholderPresent</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies whether the cardholder is present or not (if not specified, default is false)</p>
</span>,</div>
<div><span class="propName ">transactionFollowOnData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction follow-on data, if returned from the gateway, from a prior transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ConfigurationItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The configuration key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The configuration value</p>
</span></div><span class="strong">}</span><br><span class="strong">TagItem {</span>
<div><span class="propName required">key</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The tag key</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tag value</p>
</span></div><span class="strong">}</span><br><span class="strong">StoredCredentialItem {</span>
<div><span class="propWrap"><span class="propName ">transactionType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF Transaction Type</p>
</span> = <span class="propVals">['recurringInitial', 'recurringSubsequent', 'recurringResubmission', 'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission', 'merchantInitiatedIncrementalAuth',
'merchantInitiatedInitial', 'merchantInitiatedSubsequent', 'merchantInitiatedResubmission', 'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent', 'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"recurringInitial", "recurringSubsequent", "recurringResubmission", "instalmentInitial", "instalmentSubsequent", "instalmentResubmission", "merchantInitiatedIncrementalAuth", "merchantInitiatedInitial",
"merchantInitiatedSubsequent", "merchantInitiatedResubmission", "cardHolderInitiatedInitial", "cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission", "reAuthorization", "noShow", "delayedCharge",
"unscheduledCOFInitial", "unscheduledCOFSubsequent"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">numberOfInstalments</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The total number of instalments when the transaction is part of an instalment payment</p>
</span>,</div>
<div><span class="propName ">instalmentNumber</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The installment number out of the total number of instalments.</p>
</span>,</div>
<div><span class="propName ">complianceDatavalue</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The COF value returned by the gateway, This should be provided for all subsequent COF transactions</p>
</span></div><span class="strong">}</span><br><span class="strong">InvoiceData {</span>
<div><span class="propName required">invoiceId</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice identifier or check identifier</p>
</span>,</div>
<div><span class="propName required">invoiceDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The client invoice or check date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionData {</span>
<div><span class="propName ">registerId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client register id or terminal number</p>
</span>,</div>
<div><span class="propName ">clerkId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client clerk id or employee id</p>
</span>,</div>
<div><span class="propName required">transactionDate</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The transaction date and time in the client's time zone in ISO 8601 format. See <a href="https://en.wikipedia.org/wiki/ISO_8601">https://en.wikipedia.org/wiki/ISO_8601</a></p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>A client-generated reference code that is sent to the gateway and returned back in the response</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.354Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.354Z",
"referenceCode": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}</code></pre>
<small class="notice" data-sw-translate=""></small>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4 data-sw-translate="">Response Messages</h4>
<table class="fullwidth response-messages">
<thead>
<tr>
<th data-sw-translate="">HTTP Status Code</th>
<th data-sw-translate="">Reason</th>
<th data-sw-translate="">Response Model</th>
<th data-sw-translate="">Headers</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td class="markdown">
<p>BadRequest</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td class="markdown">
<p>NotFound</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td class="markdown">
<p>Conflict</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td class="markdown">
<p>InternalServerError</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">502</td>
<td class="markdown">
<p>BadGateway</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td width="15%" class="code">504</td>
<td class="markdown">
<p>GatewayTimeout</p>
</td>
<td width="50%"><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#" data-sw-translate="">Model</a></li>
<li><a class="snippet-link selected" href="#" data-sw-translate="">Example Value</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GatewayErrorResponse {</span>
<div class="readOnly"><span class="propName required">code</span> (<span class="propType">integer</span>, <span class="propReadOnly">read only</span>): <span class="propDesc markdown">
<p>The rGuest Pay numeric error code</p>
</span>,</div>
<div><span class="propWrap"><span class="propName required">reason</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The rGuest Pay error reason</p>
</span> = <span class="propVals">['clientInvalidRequest', 'clientInvalidConfiguration', 'clientInvalidDeviceGuid', 'clientInvalidTransactionId', 'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId', 'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest', 'serverInvalidConfiguration', 'deviceError', 'deviceInvalidConfiguration',
'deviceNotAvailable', 'deviceNotReady', 'deviceOperationUnsupported', 'deviceOperationAborted', 'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData', 'deviceUserPressedCancel', 'deviceUserInputTimeout',
'gatewayError', 'gatewayAuthenticationFailed', 'gatewayUnavailable', 'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest', 'transactionError', 'transactionNotFound', 'transactionInvalidState', 'transactionDuplicate',
'cardError', 'cardErrorUnsupportedCardType', 'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate', 'cardErrorUnsupportedCardIssuer', 'cardErrorChipError', 'cardErrorUnsupportedTransactionForCardType',
'cardDeclined', 'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral', 'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline', 'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound', 'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed', 'offlineTransactionNotReachedToGateway', 'offlineTransactionNotApprovedByGateway',
'offlineFloorLimitExceeded']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"clientInvalidRequest", "clientInvalidConfiguration", "clientInvalidDeviceGuid", "clientInvalidTransactionId", "clientInvalidToken", "clientInvalidTransactionState", "clientInvalidTransactionFollowOnData",
"clientInvalidPayAtTableCheckId", "clientAbortedRequest", "serverError", "serverUnsupportedRequest", "serverInvalidConfiguration", "deviceError", "deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted", "deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData", "deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable", "gatewayProcessorUnavailable", "gatewayUnsupportedRequest", "transactionError", "transactionNotFound", "transactionInvalidState", "transactionDuplicate",
"cardError", "cardErrorUnsupportedCardType", "cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate", "cardErrorUnsupportedCardIssuer", "cardErrorChipError", "cardErrorUnsupportedTransactionForCardType",
"cardDeclined", "cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral", "cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline", "payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound", "payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed", "offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName required">message</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The error message, suitable for display in a client user interface</p>
</span>,</div>
<div><span class="propName ">debugMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The debug message, suitable for logging</p>
</span>,</div>
<div><span class="propName ">validationErrors</span> (<span class="propType">Array[ValidationError]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The validation errors, if any</p>
</span>,</div>
<div><span class="propName ">transactionState</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The offline transaction state, if any, that can be used to perform an online transaction. Since the transaction state may contain encrypted card data, any transaction state that is stored by the client must be purged per
PCI requirements after the online transaction has been completed</p>
</span>,</div>
<div><span class="propName ">transactionResponseData</span> (<span class="propType">TransactionPaymentResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The transaction response data, if any when transaction state is present, containing the attempted transaction amounts</p>
</span>,</div>
<div><span class="propName ">gatewayResponseData</span> (<span class="propType">GatewayResponseData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The gateway response data, if available</p>
</span>,</div>
<div><span class="propName ">cardInfo</span> (<span class="propType">CardInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card information, such as masked account number, card issuer, etc., if available</p>
</span>,</div>
<div><span class="propName ">emvInfo</span> (<span class="propType">EmvInfo</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV information, necessary for receipt printing, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propName ">pinVerified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>Specifies if the card was verified by a PIN, if a transaction was attempted using an EMV card on a payment device</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">signatureStatus</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The signature status, if a transaction was attempted using an EMV card on a payment device</p>
</span> = <span class="propVals">['unknown', 'signaturePresent', 'signatureNotPresent', 'signatureRequired', 'signatureRequiredCancelledByCardholder', 'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired', 'signatureNotRequiredByThresholdAmount', 'signatureNotRequiredByPaymentType', 'signatureNotRequiredByTransactionType']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"unknown", "signaturePresent", "signatureNotPresent", "signatureRequired", "signatureRequiredCancelledByCardholder", "signatureRequiredNotSupportedByDevice", "singatureRequiredPinDeviceError",
"signatureNotRequired", "signatureNotRequiredByThresholdAmount", "signatureNotRequiredByPaymentType", "signatureNotRequiredByTransactionType"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">receiptData</span> (<span class="propType">ReceiptData</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The receipt data, if provided by the gateway. When provided, this must be used for printing the merchant and customer receipts</p>
</span></div><span class="strong">}</span><br><span class="strong">ValidationError {</span>
<div><span class="propName required">fieldName</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The name of the field that failed validation</p>
</span>,</div>
<div><span class="propName required">errorMessages</span> (<span class="propType">Array[string]</span>): <span class="propDesc markdown">
<p>The error messages describing the reasons for failed validation</p>
</span></div><span class="strong">}</span><br><span class="strong">TransactionPaymentResponseData {</span>
<div><span class="propName required">authorizedAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The authorized amount of the transaction which may be less than the total amount</p>
</span>,</div>
<div><span class="propName required">subTotalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The original transaction amount of the request (inclusive of tax amount but not tip amount)</p>
</span>,</div>
<div><span class="propName ">tipAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The tip amount (if any sent in the request or captured on the payment device)</p>
</span>,</div>
<div><span class="propName ">surchargeAmount</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The Surcharge amount for the transaction</p>
</span>,</div>
<div><span class="propName required">totalAmount</span> (<span class="propType">number</span>): <span class="propDesc markdown">
<p>The total amount of the transaction (subtotal amount plus tip amount)</p>
</span>,</div>
<div><span class="propName ">availableBalance</span> (<span class="propType">number</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The available balance if returned by the gateway for the card type</p>
</span></div><span class="strong">}</span><br><span class="strong">GatewayResponseData {</span>
<div><span class="propName ">decision</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The decision returned by the gateway</p>
</span>,</div>
<div><span class="propName ">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">message</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response code returned by the gateway</p>
</span>,</div>
<div><span class="propName ">processorMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The processor response message returned by the gateway</p>
</span>,</div>
<div><span class="propName ">tokenCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">tokenMessage</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The token response message returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">authCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The authorization code or approval number returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">cvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The CVV code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorCvvCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw CVV code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">avsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The AVS code returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">processorAvsCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The raw AVS code returned by the processor, if any</p>
</span>,</div>
<div><span class="propName ">referenceId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reference identifier returned by the gateway, if any</p>
</span>,</div>
<div><span class="propName ">referenceCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The client-generated reference code from the request, if any, or a value generated on behalf of the client</p>
</span>,</div>
<div><span class="propName ">reconciliationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The reconciliation identifier returned by the gateway or processor, if any</p>
</span>,</div>
<div><span class="propName ">batchId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The batch identifier returned by the gateway, if any</p>
</span></div><span class="strong">}</span><br><span class="strong">CardInfo {</span>
<div><span class="propName ">cardHolderName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The cardholder name, if available</p>
</span>,</div>
<div><span class="propName required">accountNumberMasked</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The masked account number, e.g. first six and last four digits unmasked, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardIssuer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer, if available</p>
</span> = <span class="propVals">['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub', 'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa', 'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard',
'bcCard', 'kwangju', 'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai', 'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard', 'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay',
'carteBancaire', 'electron', 'swile', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"americanExpress", "chinaUnionPay", "dankort", "dinersClub", "discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa", "interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai", "kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard", "samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">cardIssuerExtension</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card issuer extension, if available</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">cardType</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The card type, if available</p>
</span> = <span class="propVals">['credit', 'debit', 'giftCard', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"credit", "debit", "giftCard", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName ">entryMode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The entry mode, if available</p>
</span> = <span class="propVals">['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip', 'unknown']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"keyed", "swiped", "contactless", "chip", "contactlessChip", "unknown"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">expirationYearMonth</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The expiration year and month (format YYYYMM), if available</p>
</span>,</div>
<div><span class="propName ">correlationId</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The correlation id, if available</p>
</span></div><span class="strong">}</span><br><span class="strong">EmvInfo {</span>
<div><span class="propName required">isFallback</span> (<span class="propType">boolean</span>): <span class="propDesc markdown">
<p>Specifies if the EMV card was processed using fallback, e.g. if the chip was defective and the card was swiped instead</p>
</span>,</div>
<div><span class="propWrap"><span class="propName ">mode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction decision mode that specifies how the decision (approved or declined) was performed (by card or online by issuer)</p>
</span> = <span class="propVals">['card', 'issuer']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">string</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"card", "issuer"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName ">applicationIdentifier</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application identifier (AID), as obtained from EMV tag 4F, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationLabel</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application label, as obtained from EMV tag 50, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">applicationPreferredName</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV application preferred name, as obtained from EMV tag 9F12, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerCodeTableIndex</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer code table index, as obtained from EMV tag 9F11, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">issuerApplicationData</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">cryptogram</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV cryptogram as obtained from EMV tag 9F26, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">terminalVerificationResults</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV terminal verification results (TVR), as obtained from EMV tag 95, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">transactionStatusInformation</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV transaction status information (TSI), as obtained from EMV tag 9B, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">authorizationResponseCode</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV authorization response code (ARC) as obtained from EMV tag 8A, if the card was processed as EMV</p>
</span>,</div>
<div><span class="propName ">tags</span> (<span class="propType">Array[EmvTag]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tags, if the card was processed as EMV and the chip declined the transaction</p>
</span></div><span class="strong">}</span><br><span class="strong">ReceiptData {</span>
<div><span class="propName ">merchantReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The merchant receipt text lines, if provided by the gateway. When provided, this text must be used on the merchant receipt. Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span>,</div>
<div><span class="propName ">customerReceiptText</span> (<span class="propType">Array[string]</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The customer receipt text lines, if provided by the gateway. When provided, this text must be used on the customer receipt Each text line is encoded as UTF-8 and does not contain any embedded line breaks. For more
information, see section 7 of <a href="https://tools.ietf.org/html/rfc7159">https://tools.ietf.org/html/rfc7159</a></p>
</span></div><span class="strong">}</span><br><span class="strong">EmvTag {</span>
<div><span class="propName required">id</span> (<span class="propType">string</span>): <span class="propDesc markdown">
<p>The EMV tag ID</p>
</span>,</div>
<div><span class="propName ">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>): <span class="propDesc markdown">
<p>The EMV tag value</p>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<div class="snippet_json" style="display: block;">
<pre><code>{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</span></td>
<td class="headers">
<table>
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" type="submit" value="Try it out!" data-sw-translate="">
<a href="#" class="response_hider" style="display:none" data-sw-translate="">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
swagger
Explore
rGuestPay.Gateway.Webapp
* ADYENPAYATTABLE
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1.5/ADYENPAYATTABLE/NOTIFICATION
*
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
Inline Model {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
body
* Model
* Example Value
AdyenDeviceRequest {
saleTopoiRequest (SaletoPOIRequest, optional)
}
SaletoPOIRequest {
diagnosisRequest (DiagnosisRequest, optional),
reversalRequest (ReversalRequest, optional),
displayRequest (DisplayRequest, optional),
inputRequest (InputRequest, optional),
abortRequest (AbortRequest, optional),
transactionStatusRequest (TransactionStatusRequest, optional),
printRequest (PrintRequest, optional),
eventNotification (EventNotification, optional),
securityTrailer (SecurityTrailer, optional),
nexoBlob (object, optional),
messageHeader (MessageHeader, optional),
paymentRequest (PaymentRequest, optional)
}
DiagnosisRequest {
hostDiagnosisFlag (boolean, optional)
}
ReversalRequest {
reversalReason (string, optional),
originalpoiTransaction (OriginalPOITransaction, optional),
reversedAmount (number, optional),
saleData (SaleData, optional)
}
DisplayRequest {
displayOutput (Array[DisplayOutput], optional)
}
InputRequest {
displayOutput (DisplayOutput, optional),
inputData (InputData, optional)
}
AbortRequest {
abortReason (string, optional),
messageReference (MessageReference, optional)
}
TransactionStatusRequest {
messageReference (MessageReference, optional),
receiptReprintFlag (boolean, optional),
documentQualifier (Array[string], optional)
}
PrintRequest {
printOutput (PrintOutput, optional)
}
EventNotification {
eventDetails (string, optional),
eventToNotify (string, optional),
timeStamp (string, optional)
}
SecurityTrailer {
adyenCryptoVersion (integer),
keyIdentifier (string),
keyVersion (integer),
nonce (string),
hmac (string)
}
MessageHeader {
protocolVersion (string, optional),
messageClass (string, optional) = ['service', 'device', 'event']
stringEnum:"service", "device", "event"
,
messageCategory (string, optional) = ['abort', 'admin', 'balanceInquiry',
'batch', 'cardAcquisition', 'cardReaderAPDU', 'cardReaderInit',
'cardReaderPowerOff', 'diagnosis', 'display', 'enableService', 'event',
'getTotals', 'input', 'inputUpdate', 'login', 'logout', 'loyalty',
'payment', 'pIN', 'print', 'reconciliation', 'reversal', 'sound',
'storedValue', 'transactionStatus', 'transmit']
stringEnum:"abort", "admin", "balanceInquiry", "batch",
"cardAcquisition", "cardReaderAPDU", "cardReaderInit",
"cardReaderPowerOff", "diagnosis", "display", "enableService", "event",
"getTotals", "input", "inputUpdate", "login", "logout", "loyalty",
"payment", "pIN", "print", "reconciliation", "reversal", "sound",
"storedValue", "transactionStatus", "transmit"
,
messageType (string, optional) = ['request', 'response', 'notification']
stringEnum:"request", "response", "notification"
,
saleid (string, optional),
serviceid (string, optional),
poiid (string, optional),
deviceid (string, optional)
}
PaymentRequest {
paymentData (PaymentData, optional),
saleData (SaleData, optional),
paymentTransaction (PaymentTransaction, optional)
}
OriginalPOITransaction {
poiTransactionid (TransactionId, optional)
}
SaleData {
saleToAcquirerData (string, optional),
tokenRequestedType (string, optional) = ['transaction', 'customer']
stringEnum:"transaction", "customer"
,
saleTransactionid (TransactionId, optional)
}
DisplayOutput {
device (string, optional) = ['cashierDisplay', 'customerDisplay',
'cashierInput', 'customerInput']
stringEnum:"cashierDisplay", "customerDisplay", "cashierInput",
"customerInput"
,
infoQualify (string, optional) = ['status', 'error', 'display', 'sound',
'input', 'pOIReplication', 'customerAssistance', 'receipt', 'document',
'voucher']
stringEnum:"status", "error", "display", "sound", "input",
"pOIReplication", "customerAssistance", "receipt", "document", "voucher"
,
outputContent (OutputContent, optional),
menuEntry (Array[MenuEntry], optional)
}
InputData {
device (string, optional) = ['cashierDisplay', 'customerDisplay',
'cashierInput', 'customerInput']
stringEnum:"cashierDisplay", "customerDisplay", "cashierInput",
"customerInput"
,
infoQualify (string, optional) = ['status', 'error', 'display', 'sound',
'input', 'pOIReplication', 'customerAssistance', 'receipt', 'document',
'voucher']
stringEnum:"status", "error", "display", "sound", "input",
"pOIReplication", "customerAssistance", "receipt", "document", "voucher"
,
inputCommand (string, optional) = ['getAnyKey', 'getConfirmation',
'siteManager', 'textString', 'digitString', 'decimalString',
'getFunctionKey', 'getMenuEntry', 'password']
stringEnum:"getAnyKey", "getConfirmation", "siteManager", "textString",
"digitString", "decimalString", "getFunctionKey", "getMenuEntry",
"password"
,
maxInputTime (integer, optional),
minLength (integer, optional),
maxLength (integer, optional),
defaultInputString (string, optional),
stringMask (string, optional),
maskCharactersFlag (boolean, optional),
maxDecimalLength (integer, optional)
}
MessageReference {
messageCategory (string, optional) = ['abort', 'admin', 'balanceInquiry',
'batch', 'cardAcquisition', 'cardReaderAPDU', 'cardReaderInit',
'cardReaderPowerOff', 'diagnosis', 'display', 'enableService', 'event',
'getTotals', 'input', 'inputUpdate', 'login', 'logout', 'loyalty',
'payment', 'pIN', 'print', 'reconciliation', 'reversal', 'sound',
'storedValue', 'transactionStatus', 'transmit']
stringEnum:"abort", "admin", "balanceInquiry", "batch",
"cardAcquisition", "cardReaderAPDU", "cardReaderInit",
"cardReaderPowerOff", "diagnosis", "display", "enableService", "event",
"getTotals", "input", "inputUpdate", "login", "logout", "loyalty",
"payment", "pIN", "print", "reconciliation", "reversal", "sound",
"storedValue", "transactionStatus", "transmit"
,
saleid (string, optional),
serviceid (string, optional)
}
PrintOutput {
outputContent (OutputContent, optional),
documentQualifier (string, optional) = ['saleReceipt', 'cashierReceipt',
'customerReceipt', 'document', 'voucher', 'journal']
stringEnum:"saleReceipt", "cashierReceipt", "customerReceipt",
"document", "voucher", "journal"
,
responseMode (string, optional) = ['notRequired', 'immediate',
'printEnd', 'soundEnd']
stringEnum:"notRequired", "immediate", "printEnd", "soundEnd"
,
integratedPrintFlag (boolean, optional)
}
PaymentData {
paymentInstrumentData (PaymentInstrumentData, optional),
paymentType (string, optional) = ['normal', 'refund',
'oneTimeReservation', 'firstReservation', 'updateReservation',
'completion', 'cashAdvance', 'cashDeposit', 'recurring', 'instalment',
'issuerInstalment', 'paidOut']
stringEnum:"normal", "refund", "oneTimeReservation", "firstReservation",
"updateReservation", "completion", "cashAdvance", "cashDeposit",
"recurring", "instalment", "issuerInstalment", "paidOut"
,
splitPaymentFlag (boolean, optional)
}
PaymentTransaction {
amountsReq (AmountsReq, optional),
transactionConditions (TransactionConditions, optional)
}
TransactionId {
transactionid (string, optional),
timeStamp (string, optional)
}
OutputContent {
outputxhtml (string, optional),
outputFormat (string, optional) = ['messageRef', 'text', 'xHTML',
'barCode']
stringEnum:"messageRef", "text", "xHTML", "barCode"
,
predefinedContent (PredefinedContent, optional),
outputText (Array[OutputText], optional)
}
MenuEntry {
menuEntryTag (string, optional) = ['selectable', 'nonSelectable',
'subMenu', 'nonSelectableSubMenu']
stringEnum:"selectable", "nonSelectable", "subMenu",
"nonSelectableSubMenu"
,
outputFormat (string, optional) = ['messageRef', 'text', 'xHTML',
'barCode']
stringEnum:"messageRef", "text", "xHTML", "barCode"
,
outputText (Array[OutputText], optional)
}
PaymentInstrumentData {
paymentInstrumentType (string, optional) = ['card', 'check', 'mobile',
'storedValue', 'cash']
stringEnum:"card", "check", "mobile", "storedValue", "cash"
}
AmountsReq {
currency (string, optional),
requestedAmount (number, optional),
tipAmount (number, optional),
paidAmount (number, optional)
}
TransactionConditions {
forceEntryMode (Array[string], optional)
}
PredefinedContent {
referenceid (string, optional)
}
OutputText {
color (string, optional) = ['white', 'black', 'red', 'green', 'blue',
'yellow', 'magenta', 'cyan']
stringEnum:"white", "black", "red", "green", "blue", "yellow", "magenta",
"cyan"
,
characterWidth (string, optional) = ['singleWidth', 'doubleWidth']
stringEnum:"singleWidth", "doubleWidth"
,
characterHeight (string, optional) = ['singleHeight', 'doubleHeight',
'halfHeight']
stringEnum:"singleHeight", "doubleHeight", "halfHeight"
,
characterStyle (string, optional) = ['normal', 'bold', 'italic',
'underline']
stringEnum:"normal", "bold", "italic", "underline"
,
alignment (string, optional) = ['left', 'right', 'centred', 'justified']
stringEnum:"left", "right", "centred", "justified"
,
endOfLineFlag (boolean, optional),
text (string, optional)
}
{
"saleTopoiRequest": {
"diagnosisRequest": {
"hostDiagnosisFlag": true
},
"reversalRequest": {
"reversalReason": "string",
"originalpoiTransaction": {
"poiTransactionid": {
"transactionid": "string",
"timeStamp": "string"
}
},
"reversedAmount": 0,
"saleData": {
"saleToAcquirerData": "string",
"tokenRequestedType": "transaction",
"saleTransactionid": {
"transactionid": "string",
"timeStamp": "string"
}
}
},
"displayRequest": {
"displayOutput": [
{
"device": "cashierDisplay",
"infoQualify": "status",
"outputContent": {
"outputxhtml": "string",
"outputFormat": "messageRef",
"predefinedContent": {
"referenceid": "string"
},
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
},
"menuEntry": [
{
"menuEntryTag": "selectable",
"outputFormat": "messageRef",
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
}
]
}
]
},
"inputRequest": {
"displayOutput": {
"device": "cashierDisplay",
"infoQualify": "status",
"outputContent": {
"outputxhtml": "string",
"outputFormat": "messageRef",
"predefinedContent": {
"referenceid": "string"
},
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
},
"menuEntry": [
{
"menuEntryTag": "selectable",
"outputFormat": "messageRef",
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
}
]
},
"inputData": {
"device": "cashierDisplay",
"infoQualify": "status",
"inputCommand": "getAnyKey",
"maxInputTime": 0,
"minLength": 0,
"maxLength": 0,
"defaultInputString": "string",
"stringMask": "string",
"maskCharactersFlag": true,
"maxDecimalLength": 0
}
},
"abortRequest": {
"abortReason": "string",
"messageReference": {
"messageCategory": "abort",
"saleid": "string",
"serviceid": "string"
}
},
"transactionStatusRequest": {
"messageReference": {
"messageCategory": "abort",
"saleid": "string",
"serviceid": "string"
},
"receiptReprintFlag": true,
"documentQualifier": [
"string"
]
},
"printRequest": {
"printOutput": {
"outputContent": {
"outputxhtml": "string",
"outputFormat": "messageRef",
"predefinedContent": {
"referenceid": "string"
},
"outputText": [
{
"color": "white",
"characterWidth": "singleWidth",
"characterHeight": "singleHeight",
"characterStyle": "normal",
"alignment": "left",
"endOfLineFlag": true,
"text": "string"
}
]
},
"documentQualifier": "saleReceipt",
"responseMode": "notRequired",
"integratedPrintFlag": true
}
},
"eventNotification": {
"eventDetails": "string",
"eventToNotify": "string",
"timeStamp": "string"
},
"securityTrailer": {
"adyenCryptoVersion": 0,
"keyIdentifier": "string",
"keyVersion": 0,
"nonce": "string",
"hmac": "string"
},
"nexoBlob": {},
"messageHeader": {
"protocolVersion": "string",
"messageClass": "service",
"messageCategory": "abort",
"messageType": "request",
"saleid": "string",
"serviceid": "string",
"poiid": "string",
"deviceid": "string"
},
"paymentRequest": {
"paymentData": {
"paymentInstrumentData": {
"paymentInstrumentType": "card"
},
"paymentType": "normal",
"splitPaymentFlag": true
},
"saleData": {
"saleToAcquirerData": "string",
"tokenRequestedType": "transaction",
"saleTransactionid": {
"transactionid": "string",
"timeStamp": "string"
}
},
"paymentTransaction": {
"amountsReq": {
"currency": "string",
"requestedAmount": 0,
"tipAmount": 0,
"paidAmount": 0
},
"transactionConditions": {
"forceEntryMode": [
"string"
]
}
}
}
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CARD
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1.5/CARD/INFO
* Returns the information for a card using the specified encrypted card
data
IMPLEMENTATION NOTES
Returns the information for a card using the specified encrypted card
data
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CardInfoResponse {
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.
,
postalCode (string, optional):
The postal code, if available
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
{
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"postalCode": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The card balance request
body
* Model
* Example Value
CardInfoRequest {
encryptedCardData (EncryptedCardData):
The encrypted credit card data
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/CARD/BALANCE/DEVICE/{DEVICEGUID}
* Returns the available balance on a card using the specified payment
device for card capture
IMPLEMENTATION NOTES
Returns the available balance on a card using the specified payment
device for card capture, if the gateway supports a card balance request
for the given card type.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CardBalanceResponse {
availableBalance (number):
The card account balance
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
{
"availableBalance": 0,
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The card balance request
body
* Model
* Example Value
CardBalanceOnDeviceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
manualCardEntry (boolean, optional):
Specifies whether or not the device will prompt for manual card entry
instead of swipe/tap (if supported by the device/gateway)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"manualCardEntry": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/CARD/BALANCE/TOKEN/{TOKEN}
* Returns the available balance on a card using the specified token
IMPLEMENTATION NOTES
Returns the available balance on a card using the specified token, if the
gateway supports a card balance request for the given card type.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CardBalanceResponse {
availableBalance (number):
The card account balance
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
{
"availableBalance": 0,
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token
The card token.
path string request
Parameter content type: application/json text/json
The card balance request.
body
* Model
* Example Value
CardBalanceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/CARD/BALANCE
* Returns the available balance on a card using the specified encrypted
card data
IMPLEMENTATION NOTES
Returns the available balance on a card using the specified encrypted
card data, if the gateway supports a card balance request for the given
card type.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CardBalanceResponse {
availableBalance (number):
The card account balance
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
{
"availableBalance": 0,
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The card balance request
body
* Model
* Example Value
CardBalanceWithCardDataRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
encryptedCardData (EncryptedCardData):
The encrypted credit card data
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DEVICE
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1.5/DEVICE/LIST
* Returns a list of configured payment devices
IMPLEMENTATION NOTES
Returns a list of configured payment devices.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
GetDeviceListResponse {
devices (Array[DeviceInfo], optional):
The devices
}
DeviceInfo {
deviceGuid (string):
The device GUID
,
handlerId (string):
The device handler ID
,
deviceNumber (integer):
The device number
,
handlerStatus (string):
The device handler status
= ['none', 'created', 'initializing', 'initialized', 'shuttingDown',
'shutdown', 'failed']
stringEnum:"none", "created", "initializing", "initialized",
"shuttingDown", "shutdown", "failed"
,
deviceStatus (string):
The device status
= ['unknown', 'available', 'notAvailable', 'updating', 'failed']
stringEnum:"unknown", "available", "notAvailable", "updating", "failed"
,
statusMessage (string, optional):
The status message (if any)
,
handler (string):
The device handler name
,
manufacturer (string, optional):
The device manufacturer
,
product (string, optional):
The device product
,
description (string):
The device "friendly" description (suitable for display when selecting
amongst multiple devices)
,
deviceType (string):
The device type
,
devicePath (string):
Gets or sets the device path.
,
serialNumber (string):
The serial number
,
serialNumber2 (string):
The serial number 2
,
extendedData (Array[DeviceInfoExtendedDataItem], optional):
The extended data, if any. This is an optional collection of data useful
for diagnostics or troubleshooting
}
DeviceInfoExtendedDataItem {
key (string):
The data item key
,
value (string, optional):
The data item value
}
{
"devices": [
{
"deviceGuid": "00000000-0000-0000-0000-000000000000",
"handlerId": "string",
"deviceNumber": 0,
"handlerStatus": "none",
"deviceStatus": "unknown",
"statusMessage": "string",
"handler": "string",
"manufacturer": "string",
"product": "string",
"description": "string",
"deviceType": "string",
"devicePath": "string",
"serialNumber": "string",
"serialNumber2": "string",
"extendedData": [
{
"key": "string",
"value": "string"
}
]
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type includeExtendedData
true false
[optional] true to include extended device data (for diagnostics or
troubleshooting); otherwise false.
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 202
Accepted
* Model
* Example Value
GetDeviceListResponse {
devices (Array[DeviceInfo], optional):
The devices
}
DeviceInfo {
deviceGuid (string):
The device GUID
,
handlerId (string):
The device handler ID
,
deviceNumber (integer):
The device number
,
handlerStatus (string):
The device handler status
= ['none', 'created', 'initializing', 'initialized', 'shuttingDown',
'shutdown', 'failed']
stringEnum:"none", "created", "initializing", "initialized",
"shuttingDown", "shutdown", "failed"
,
deviceStatus (string):
The device status
= ['unknown', 'available', 'notAvailable', 'updating', 'failed']
stringEnum:"unknown", "available", "notAvailable", "updating", "failed"
,
statusMessage (string, optional):
The status message (if any)
,
handler (string):
The device handler name
,
manufacturer (string, optional):
The device manufacturer
,
product (string, optional):
The device product
,
description (string):
The device "friendly" description (suitable for display when selecting
amongst multiple devices)
,
deviceType (string):
The device type
,
devicePath (string):
Gets or sets the device path.
,
serialNumber (string):
The serial number
,
serialNumber2 (string):
The serial number 2
,
extendedData (Array[DeviceInfoExtendedDataItem], optional):
The extended data, if any. This is an optional collection of data useful
for diagnostics or troubleshooting
}
DeviceInfoExtendedDataItem {
key (string):
The data item key
,
value (string, optional):
The data item value
}
{
"devices": [
{
"deviceGuid": "00000000-0000-0000-0000-000000000000",
"handlerId": "string",
"deviceNumber": 0,
"handlerStatus": "none",
"deviceStatus": "unknown",
"statusMessage": "string",
"handler": "string",
"manufacturer": "string",
"product": "string",
"description": "string",
"deviceType": "string",
"devicePath": "string",
"serialNumber": "string",
"serialNumber2": "string",
"extendedData": [
{
"key": "string",
"value": "string"
}
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.5/DEVICE/{DEVICEGUID}
* Returns the device info for the specified payment device
IMPLEMENTATION NOTES
Returns the device info for the specified payment device.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
GetDeviceInfoResponse {
deviceInfo (DeviceInfo, optional):
The device info
}
DeviceInfo {
deviceGuid (string):
The device GUID
,
handlerId (string):
The device handler ID
,
deviceNumber (integer):
The device number
,
handlerStatus (string):
The device handler status
= ['none', 'created', 'initializing', 'initialized', 'shuttingDown',
'shutdown', 'failed']
stringEnum:"none", "created", "initializing", "initialized",
"shuttingDown", "shutdown", "failed"
,
deviceStatus (string):
The device status
= ['unknown', 'available', 'notAvailable', 'updating', 'failed']
stringEnum:"unknown", "available", "notAvailable", "updating", "failed"
,
statusMessage (string, optional):
The status message (if any)
,
handler (string):
The device handler name
,
manufacturer (string, optional):
The device manufacturer
,
product (string, optional):
The device product
,
description (string):
The device "friendly" description (suitable for display when selecting
amongst multiple devices)
,
deviceType (string):
The device type
,
devicePath (string):
Gets or sets the device path.
,
serialNumber (string):
The serial number
,
serialNumber2 (string):
The serial number 2
,
extendedData (Array[DeviceInfoExtendedDataItem], optional):
The extended data, if any. This is an optional collection of data useful
for diagnostics or troubleshooting
}
DeviceInfoExtendedDataItem {
key (string):
The data item key
,
value (string, optional):
The data item value
}
{
"deviceInfo": {
"deviceGuid": "00000000-0000-0000-0000-000000000000",
"handlerId": "string",
"deviceNumber": 0,
"handlerStatus": "none",
"deviceStatus": "unknown",
"statusMessage": "string",
"handler": "string",
"manufacturer": "string",
"product": "string",
"description": "string",
"deviceType": "string",
"devicePath": "string",
"serialNumber": "string",
"serialNumber2": "string",
"extendedData": [
{
"key": "string",
"value": "string"
}
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The device unique identifier.
path string includeExtendedData true false
[optional] true to include extended device data (for diagnostics or
troubleshooting); otherwise false.
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/DEVICE/{DEVICEGUID}/DETACH
* Detaches the rGuest Pay Agent from the specified payment device
IMPLEMENTATION NOTES
Detaches the rGuest Pay Agent from the specified payment device.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
DeviceOperationResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The device unique identifier.
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/DEVICE/{DEVICEGUID}/LANE/STATE/{LANESTATE}
* Sets the lane state to either open or closed
IMPLEMENTATION NOTES
Sets the lane state to either open or closed.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
DeviceOperationResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The device unique identifier.
path string laneState open closed
The lane state (e.g. open/closed).
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/DEVICE/{DEVICEGUID}/STANDBY
* Resets the specified payment device to the advertising/idle screen and
terminates any current device operations
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
StandbyDeviceResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The device unique identifier.
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HEALTH
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1.5/HEALTH
* Performs a basic health check to verify the rGuest Pay Agent is
running and actively accepting connections
IMPLEMENTATION NOTES
Performs a basic health check to verify the rGuest Pay Agent is running
and actively accepting connections.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
HealthResponse {
name (string):
The rGuest Pay product name
,
version (string):
The rGuest Pay product version
}
{
"name": "string",
"version": "string"
}
Response Content Type application/json text/json
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.5/HEALTH/DETAIL
* Performs a detailed health check for the rGuest Pay Agent and returns
the current health status information
IMPLEMENTATION NOTES
Performs a detailed health check for the rGuest Pay Agent and returns the
current health status information.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
HealthDetailResponse {
name (string):
The rGuest Pay product name
,
version (string):
The rGuest Pay product version
,
isHealthy (boolean):
Specifies if the rGuest Pay Agent is healthy (true only if all the
monitored service groups are healthy)
,
handlerGroups (Array[RegisteredHandlerGroupInfo]):
The registered handler groups for the rGuest Pay Agent
,
serviceGroups (Array[MonitoredServiceGroupInfo]):
The monitored service groups for the rGuest Pay Agent
}
RegisteredHandlerGroupInfo {
id (string):
The handler group identifier
,
version (string):
The handler group version
,
handlers (Array[RegisteredHandlerInfo]):
The installed handlers for the handler group
}
MonitoredServiceGroupInfo {
id (string):
The service group identifier
,
isHealthy (boolean):
Specifies if the service group is healthy (true only if none of the
monitored services are not available)
,
services (Array[MonitoredServiceInfo]):
The monitored services for the service group
}
RegisteredHandlerInfo {
type (string):
The registered handler type
= ['device', 'gateway']
stringEnum:"device", "gateway"
}
MonitoredServiceInfo {
id (string):
The service identifier
,
status (string):
The service status
= ['unknown', 'available', 'notAvailable']
stringEnum:"unknown", "available", "notAvailable"
}
{
"name": "string",
"version": "string",
"isHealthy": true,
"handlerGroups": [
{
"id": "string",
"version": "string",
"handlers": [
{
"type": "device"
}
]
}
],
"serviceGroups": [
{
"id": "string",
"isHealthy": true,
"services": [
{
"id": "string",
"status": "unknown"
}
]
}
]
}
Response Content Type application/json text/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 503
ServiceUnavailable
* Model
* Example Value
HealthDetailResponse {
name (string):
The rGuest Pay product name
,
version (string):
The rGuest Pay product version
,
isHealthy (boolean):
Specifies if the rGuest Pay Agent is healthy (true only if all the
monitored service groups are healthy)
,
handlerGroups (Array[RegisteredHandlerGroupInfo]):
The registered handler groups for the rGuest Pay Agent
,
serviceGroups (Array[MonitoredServiceGroupInfo]):
The monitored service groups for the rGuest Pay Agent
}
RegisteredHandlerGroupInfo {
id (string):
The handler group identifier
,
version (string):
The handler group version
,
handlers (Array[RegisteredHandlerInfo]):
The installed handlers for the handler group
}
MonitoredServiceGroupInfo {
id (string):
The service group identifier
,
isHealthy (boolean):
Specifies if the service group is healthy (true only if none of the
monitored services are not available)
,
services (Array[MonitoredServiceInfo]):
The monitored services for the service group
}
RegisteredHandlerInfo {
type (string):
The registered handler type
= ['device', 'gateway']
stringEnum:"device", "gateway"
}
MonitoredServiceInfo {
id (string):
The service identifier
,
status (string):
The service status
= ['unknown', 'available', 'notAvailable']
stringEnum:"unknown", "available", "notAvailable"
}
{
"name": "string",
"version": "string",
"isHealthy": true,
"handlerGroups": [
{
"id": "string",
"version": "string",
"handlers": [
{
"type": "device"
}
]
}
],
"serviceGroups": [
{
"id": "string",
"isHealthy": true,
"services": [
{
"id": "string",
"status": "unknown"
}
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.5/HEALTH/TERMINAL
* Performs a detailed terminal health check where the rGuest Pay Agent
is installed, and returns the current terminal information
IMPLEMENTATION NOTES
Performs a detailed terminal health check where the rGuest Pay Agent is
installed, and returns the current terminal information
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
TerminalDetails {
ipAddress (string):
The IP address of the terminal
,
hostName (string):
The host name of the terminal
,
userName (string, optional):
The user name associated with the terminal
,
machineId (string, optional):
The machine ID of the terminal
,
osVersion (string, optional):
The operating system version of the terminal
,
country (string, optional):
The country where the terminal is located
,
payAgentVersion (string, optional):
The name and version of the installed payment agent.
}
{
"ipAddress": "string",
"hostName": "string",
"userName": "string",
"machineId": "string",
"osVersion": "string",
"country": "string",
"payAgentVersion": "string"
}
Response Content Type application/json text/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ONDEMAND
* Show/Hide
* List Operations
* Expand Operations
* * GET /V1.5/ONDEMAND/CARDCAPTURE/DEVICE/{DEVICEGUID}
* Reads the captured card data from the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ReadCardDataResponse {
cardData (CardData):
The captured card data
}
CardData {
accountName (string, optional):
The account name
,
accountNumber (string, optional):
The account number
,
expirationDate (string, optional):
The expiration date
,
cvv2 (string, optional):
The CVV2
,
postalCode (string, optional):
The postal code
,
track1 (string, optional):
The track 1 data
,
track2 (string, optional):
The track 2 data
,
cardDataSource (string, optional):
The card data source
= ['magSwipe', 'manual', 'nFCRFID']
stringEnum:"magSwipe", "manual", "nFCRFID"
,
encryptionType (string, optional):
The encryption type
= ['none', 'p2PE']
stringEnum:"none", "p2PE"
,
p2peData (P2PEData, optional):
The P2PE data
}
P2PEData {
deviceType (string, optional):
The device type
,
deviceIdentifier (string, optional):
The device identifier
,
encryptionIdentifier (string, optional):
The encryption identifier
,
encryptedData1 (string, optional):
The encrypted data 1
,
encryptedData2 (string, optional):
The encrypted data 2
,
additionalData (Array[AdditionalData], optional):
The additional data
}
AdditionalData {
name (string):
The name
,
value (string, optional):
The value
}
{
"cardData": {
"accountName": "string",
"accountNumber": "string",
"expirationDate": "string",
"cvv2": "string",
"postalCode": "string",
"track1": "string",
"track2": "string",
"cardDataSource": "magSwipe",
"encryptionType": "none",
"p2peData": {
"deviceType": "string",
"deviceIdentifier": "string",
"encryptionIdentifier": "string",
"encryptedData1": "string",
"encryptedData2": "string",
"additionalData": [
{
"name": "string",
"value": "string"
}
]
}
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 202
Accepted
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/CARDCAPTURE/DEVICE/{DEVICEGUID}
* Prompts for card capture on the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
PromptCardCaptureResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt card capture request
body
* Model
* Example Value
PromptCardCaptureRequest {
amount (number, optional):
The amount
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"amount": 0,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.5/ONDEMAND/TIPCAPTURE/DEVICE/{DEVICEGUID}
* Reads the captured tip amount data from the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ReadTipAmountResponse {
tipAmountType (string):
The tip amount type
= ['amount', 'percent']
stringEnum:"amount", "percent"
,
tipAmount (number):
The tip amount value (ex: 20.00 for 20%, or 1.5 for $1.50)
}
{
"tipAmountType": "amount",
"tipAmount": 0
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 202
Accepted
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/TIPCAPTURE/DEVICE/{DEVICEGUID}
* Prompts for tip on the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
PromptTipAmountResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt tip amount request.
body
* Model
* Example Value
PromptTipAmountRequest {
amount (number, optional):
The subtotal amount to prompt for tip
,
tipPromptData (TipPromptData, optional):
The tip prompt data for this request (e.g. tip seed, tip presets)
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used
}
TipPromptData {
tipSeedAmount (number, optional):
If specified, this amount is "seeded" as the suggested tip amount on the
device
,
tipPresetValueType (string):
Specifies the tip preset type to be used, if available, on the device
= ['none', 'amount', 'percent']
stringEnum:"none", "amount", "percent"
,
tipPreset1 (number, optional):
The first tip preset value
,
tipPreset2 (number, optional):
The second tip preset value
,
tipPreset3 (number, optional):
The third tip preset value
,
tipPreset4 (number, optional):
The fourth tip preset value
,
tipBasisAmount (number, optional):
Tip Basis Amount. If the value is set, tip amount calculation will be
based on this value.
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"amount": 0,
"tipPromptData": {
"tipSeedAmount": 0,
"tipPresetValueType": "none",
"tipPreset1": 0,
"tipPreset2": 0,
"tipPreset3": 0,
"tipPreset4": 0,
"tipBasisAmount": 0
},
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.5/ONDEMAND/SIGNATURECAPTURE/DEVICE/{DEVICEGUID}
* Reads the captured signature data from the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ReadSignatureCaptureResponse {
signatureData (SvgSignatureData):
The signature data in svg format
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 202
Accepted
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/SIGNATURECAPTURE/DEVICE/{DEVICEGUID}
* Prompts for signature capture on the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
PromptSignatureCaptureResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt for signature capture request.
body
* Model
* Example Value
PromptSignatureCaptureRequest {
amount (number, optional):
The total amount, including tip, to show on the signature capture screen
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"amount": 0,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/SELECTION/DEVICE/{DEVICEGUID}
* Prompts for the specified selection form on the specified payment
device, and waits for the guest to interact
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SelectionFormResponse {
selectedButtonId (string):
This value is the id of the button provided in the request that was
selected by the guest; when the request formType "yesNoTextArea" is
specified, "No" will be button Id "1", while "Yes" will be buttonId "2"
,
selectedButtonText (string):
This value is text of the button provided in the request that was
selected by the guest
}
{
"selectedButtonId": "string",
"selectedButtonText": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt for selection request
body
* Model
* Example Value
SelectionFormRequest {
formType (string):
Gets or sets the type of selection form
= ['multiButtonTextArea', 'multiButton', 'yesNoTextArea']
stringEnum:"multiButtonTextArea", "multiButton", "yesNoTextArea"
,
header (string, optional):
Sets text on the header control on the form, if the form has one. For
FormType "MultiOption", this sets the value in the single line prompt
field on the form
,
subHeader (string, optional):
Sets text on the sub header control on the form, if the form has one.
Ignored if FormType is "MultiOption"
,
text (string, optional):
Sets text on the multiline text area control, if the form has one.
Ignored if FormType is "MultiOption"
,
buttons (Array[SelectionFormButton], optional):
A collection of selection form buttons to display on the selection form.
Ignored if FormType is "YesNoTextArea"
,
afterUserInputAction (string, optional):
Specifies the action the device should take after the user interacts with
the device; if not specified, defaults to processing
= ['processing', 'idle', 'none']
stringEnum:"processing", "idle", "none"
}
SelectionFormButton {
id (string):
The button's selection identifier; when this button is selected, this id
is returned as the selected button id
,
text (string):
The button text to display on the button; when this button is selected,
this text is returned as the selected button text
}
{
"formType": "multiButtonTextArea",
"header": "string",
"subHeader": "string",
"text": "string",
"buttons": [
{
"id": "string",
"text": "string"
}
],
"afterUserInputAction": "processing"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/MESSAGE/DEVICE/{DEVICEGUID}
* Prompts the message form with the specified text on the specified
payment device, and returns immediately
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
MessageFormResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt for message request
body
* Model
* Example Value
MessageFormRequest {
text (string, optional):
The message text to display on the message form. Defaults to "Processing,
please wait..." if not specified
}
{
"text": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/SIGNATURE/DEVICE/{DEVICEGUID}
* Prompts for the specified signature form on the specified payment
deivce, and waits for the guest to interact
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SignatureFormResponse {
signatureData (SvgSignatureData):
The signature data in svg format
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt for signature request
body
* Model
* Example Value
SignatureFormRequest {
formType (string):
Gets or sets the type of signature form
= ['standard', 'textArea']
stringEnum:"standard", "textArea"
,
header (string, optional):
Sets text on the header control on the form, if the form has one; if not
specified, the device will display a default signature prompt
,
subHeader (string, optional):
Sets text on the sub header control on the form, if the form has one.
Ignored if formType is "Standard"
,
text (string, optional):
Sets text on the multiline text area control, if the form has one.
Ignored if formType is "Standard"
,
afterUserInputAction (string, optional):
Specifies the action the device should take after the user interacts with
the device; if not specified, defaults to idle
= ['processing', 'idle', 'none']
stringEnum:"processing", "idle", "none"
}
{
"formType": "standard",
"header": "string",
"subHeader": "string",
"text": "string",
"afterUserInputAction": "processing"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/CUSTOMFORM/DEVICE/{DEVICEGUID}
* Prompts for the specified custom form on the specified payment device,
and waits for the guest to interact
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CustomFormResponse {
selectedButtonId (string):
This value is the id of the button provided in the request that was
selected by the guest; when the request formType "yesNoTextArea" is
specified, "No" will be button Id "1", while "Yes" will be buttonId "2"
,
selectedButtonText (string):
This value is text of the button selected by the guest provided in the
request
}
{
"selectedButtonId": "string",
"selectedButtonText": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt for custom form request
body
* Model
* Example Value
CustomFormRequest {
formId (string):
Gets or sets the custom form id
,
formType (string):
Gets or sets the type of custom form
= ['multiButtonTextArea', 'multiButton', 'yesNoTextArea']
stringEnum:"multiButtonTextArea", "multiButton", "yesNoTextArea"
,
header (string, optional):
Sets text on the header control on the form, if the form has one. For
FormType "MultiOption", this sets the value in the single line prompt
field on the form
,
subHeader (string, optional):
Sets text on the sub header control on the form, if the form has one.
Ignored if FormType is "MultiOption"
,
text (string, optional):
Sets text on the multiline text area control, if the form has one.
Ignored if FormType is "MultiOption"
,
buttons (Array[CustomFormButton], optional):
A collection of custom form buttons to display on the custom form.
Ignored if FormType is "YesNoTextArea"
,
labels (Array[CustomFormLabel], optional):
A collection of custom form labels to display on the custom form.
,
afterUserInputAction (string, optional):
Specifies the action the device should take after the user interacts with
the device; if not specified, defaults to processing
= ['processing', 'idle', 'none']
stringEnum:"processing", "idle", "none"
}
CustomFormButton {
id (string):
The button's selection identifier; when this button is selected, this id
is returned as the selected button id
,
text (string):
The button text to display on the button; when this button is selected,
this text is returned as the selected button text
}
CustomFormLabel {
id (string, optional):
The label's identifier on the custom form;
,
text (string, optional):
The label text to display on the custom form;
}
{
"formId": "string",
"formType": "multiButtonTextArea",
"header": "string",
"subHeader": "string",
"text": "string",
"buttons": [
{
"id": "string",
"text": "string"
}
],
"labels": [
{
"id": "string",
"text": "string"
}
],
"afterUserInputAction": "processing"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /V1.5/ONDEMAND/SECURITYCODE/DEVICE/{DEVICEGUID}
* Reads the captured security code from the specified payment device
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ReadSecurityCodeResponse {
securityCode (string, optional):
Gets or sets the security code.
}
{
"securityCode": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 202
Accepted
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/ONDEMAND/SECURITYCODE/DEVICE/{DEVICEGUID}
* Prompts for security code on the specified payment device.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
PromptSecurityCodeResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The prompt for security code request
body
* Model
* Example Value
PromptSecurityCodeRequest {}
{}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* OPERATION
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1.5/OPERATION/LOGCAPTURE
* Returns the response for log capture operation
IMPLEMENTATION NOTES
Returns the response for log capture operation
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
LogCaptureResponse {
decision (string, optional):
The decision returned by the service
,
code (string, optional):
The response code returned by the service
,
message (string, optional):
The response message returned by the service
}
{
"decision": "string",
"code": "string",
"message": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The log capture request
body
* Model
* Example Value
LogCaptureRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
logFilePath (string, optional):
The log file path.
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"logFilePath": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
404
NotFound
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
504
GatewayTimeout
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/OPERATION/EODBATCHPROCESS
* Performs the End Of Day(EOD) signal request for batch process
IMPLEMENTATION NOTES
Performs the End Of Day(EOD) signal request for batch process
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
EODBatchProcessResponse {
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
{
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The end of day(EOD) batch process request
body
* Model
* Example Value
EODBatchProcessRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
404
NotFound
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
504
GatewayTimeout
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PAYATTABLE
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1.5/PAYATTABLE/CHECK
* Opens a Pay-at-Table check and returns the Pay-at-Table check
identifier
IMPLEMENTATION NOTES
Opens a Pay-at-Table check with the specified check information in the
request and returns the Pay-at-Table check identifier in the response.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
OpenPayAtTableCheckResponse {
checkId (string):
The Pay-at-Table check identifier
}
{
"checkId": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The Pay-at-Table open check request.
body
* Model
* Example Value
OpenPayAtTableCheckRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
checkData (PayAtTableCheckData):
The Pay-at-Table check data
,
messageData (PayAtTableMessageData, optional):
The Pay-at-Table message data; if specified, this allows optional
information to be displayed on the device when the check is brought up
(actual functionality depends on specific device capability)
,
receiptData (PayAtTableReceiptData, optional):
The Pay-at-Table receipt data; if specified, this allows optional
information to be displayed on the receipt when the receipt is printed
(actual functionality depends on specific gateway and device capability).
Note: any text provided in receipt data should typically be in the same
language as specified for the culture name of the merchant
,
cultureName (string, optional):
The ISO culture name (e.g. "en-US", "en-GB", "fr-FR", "fr-CA") which must
be a combination of an ISO-639 two-letter culture code associated with a
language and an ISO-3166 two-letter uppercase subculture code associated
with a country or region. See https://en.wikipedia.org/wiki/ISO_639 and
https://en.wikipedia.org/wiki/ISO_3166 for more information. Note: this
culture name represents the culture (language and country/region) in
which the merchant is doing business and directly affects the regional
formatting for date/time values and amount values. If not specified, the
current culture of the rGuest Pay environment is assumed
,
currencyCode (string, optional):
The ISO currency code (e.g. "USD", "EUR", "GBP", "JPY") which must be an
ISO-4217 three-letter alphabetic currency code. See
https://en.wikipedia.org/wiki/ISO_4217 for more information. Note: this
currency code represents the currency in which the merchant is doing
business. If not specified, the currency code for the region of the
current culture of the rGuest Pay environment is assumed
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
PayAtTableCheckData {
checkNumber (string):
The client check number
,
checkOpenDate (string):
The client check open date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
locationId (string, optional):
The client location id (such as as profit center id or sales outlet id)
,
registerId (string, optional):
The client register id or terminal number
,
clerkId (string):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
,
tableNumber (string, optional):
The client table number
,
totalAmount (number):
The total amount of the check (inclusive of tax amount)
,
taxAmount (number, optional):
The tax amount, if any, of the check (this amount is included in the
total amount)
,
unpaidAmount (number):
The current unpaid amount on the check (this is the remaining amount due
on the check)
,
tipBasisAmount (number, optional):
Tip Basis Amount. If the value is set, tip amount calculation will be
based on this value
,
accessFilters (PayAtTableAccessFilters, optional):
The access filter(s), if any. This allows optional information that can
be used to classify the check(s)
}
PayAtTableMessageData {
messageLine1 (string, optional):
The message text for the first display line on the payment device (this
allows optional information to be displayed on the device when the check
is brought up; actual functionality depends on specific device
capability)
,
messageLine2 (string, optional):
The message text for the second display line on the payment device (this
allows optional information to be displayed on the device when the check
is brought up; actual functionality depends on specific device
capability)
}
PayAtTableReceiptData {
headerText (Array[string], optional):
The optional receipt header text that should contain the merchant's
business name, business address, and other relevant information to be
printed at the top of the receipt (however, actual functionality depends
on specific gateway and device capability including the length of lines
and any necessary wrapping of long text across lines). Note: this text
should typically be in the same language as specified for the culture of
the merchant. Each text line should be encoded as UTF-8 and should not
contain any embedded line breaks. For more information, see section 7 of
https://tools.ietf.org/html/rfc7159
,
checkItemsData (Array[CheckItem], optional):
Gets or sets the Pay-at-Table check items (if any).
}
PayAtTableAccessFilters {
clerks (Array[PayAtTableClerk], optional):
The additional clerk(s) can be mapped to the check
}
CheckItem {
amount (number, optional):
The amount of the ordered item
,
description (string, optional):
The description
,
quantity (integer, optional):
The quantity of the item
}
PayAtTableClerk {
clerkId (string, optional):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"checkData": {
"checkNumber": "string",
"checkOpenDate": "2024-09-02T20:03:47.984Z",
"locationId": "string",
"registerId": "string",
"clerkId": "string",
"clerkCardNumber": "string",
"tableNumber": "string",
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0,
"tipBasisAmount": 0,
"accessFilters": {
"clerks": [
{
"clerkId": "string",
"clerkCardNumber": "string"
}
]
}
},
"messageData": {
"messageLine1": "string",
"messageLine2": "string"
},
"receiptData": {
"headerText": [
"string"
],
"checkItemsData": [
{
"amount": 0,
"description": "string",
"quantity": 0
}
]
},
"cultureName": "string",
"currencyCode": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /V1.5/PAYATTABLE/CHECK/{CHECKID}
* Updates an existing Pay-at-Table check for the specified Pay-at-Table
check identifier
IMPLEMENTATION NOTES
Updates an existing Pay-at-Table check for the specified Pay-at-Table
check identifier with the specified check information in the request.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
UpdatePayAtTableCheckResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type checkId
The Pay-at-Table check identifier.
path string request
Parameter content type: application/json text/json
The Pay-at-Table update check request.
body
* Model
* Example Value
UpdatePayAtTableCheckRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
checkData (PayAtTableCheckData):
The Pay-at-Table check data
,
messageData (PayAtTableMessageData, optional):
The Pay-at-Table message data; if specified, this allows optional
information to be displayed on the device when the check is brought up
(actual functionality depends on specific device capability)
,
receiptData (PayAtTableReceiptData, optional):
The Pay-at-Table receipt data; if specified, this allows optional
information to be displayed on the receipt when the receipt is printed
(actual functionality depends on specific gateway and device capability).
Note: any text provided in receipt data should typically be in the same
language as specified for the culture name of the merchant
,
cultureName (string, optional):
The ISO culture name (e.g. "en-US", "en-GB", "fr-FR", "fr-CA") which must
be a combination of an ISO-639 two-letter culture code associated with a
language and an ISO-3166 two-letter uppercase subculture code associated
with a country or region. See https://en.wikipedia.org/wiki/ISO_639 and
https://en.wikipedia.org/wiki/ISO_3166 for more information. Note: this
culture name represents the culture (language and country/region) in
which the merchant is doing business and directly affects the regional
formatting for date/time values and amount values. If not specified, the
current culture of the rGuest Pay environment is assumed
,
currencyCode (string, optional):
The ISO currency code (e.g. "USD", "EUR", "GBP", "JPY") which must be an
ISO-4217 three-letter alphabetic currency code. See
https://en.wikipedia.org/wiki/ISO_4217 for more information. Note: this
currency code represents the currency in which the merchant is doing
business. If not specified, the currency code for the region of the
current culture of the rGuest Pay environment is assumed
,
inquiryRequest (string, optional):
The Inquiry Request
,
inquiryRetryCount (integer, optional):
The Inquiry RetryCount
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
PayAtTableCheckData {
checkNumber (string):
The client check number
,
checkOpenDate (string):
The client check open date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
locationId (string, optional):
The client location id (such as as profit center id or sales outlet id)
,
registerId (string, optional):
The client register id or terminal number
,
clerkId (string):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
,
tableNumber (string, optional):
The client table number
,
totalAmount (number):
The total amount of the check (inclusive of tax amount)
,
taxAmount (number, optional):
The tax amount, if any, of the check (this amount is included in the
total amount)
,
unpaidAmount (number):
The current unpaid amount on the check (this is the remaining amount due
on the check)
,
tipBasisAmount (number, optional):
Tip Basis Amount. If the value is set, tip amount calculation will be
based on this value
,
accessFilters (PayAtTableAccessFilters, optional):
The access filter(s), if any. This allows optional information that can
be used to classify the check(s)
}
PayAtTableMessageData {
messageLine1 (string, optional):
The message text for the first display line on the payment device (this
allows optional information to be displayed on the device when the check
is brought up; actual functionality depends on specific device
capability)
,
messageLine2 (string, optional):
The message text for the second display line on the payment device (this
allows optional information to be displayed on the device when the check
is brought up; actual functionality depends on specific device
capability)
}
PayAtTableReceiptData {
headerText (Array[string], optional):
The optional receipt header text that should contain the merchant's
business name, business address, and other relevant information to be
printed at the top of the receipt (however, actual functionality depends
on specific gateway and device capability including the length of lines
and any necessary wrapping of long text across lines). Note: this text
should typically be in the same language as specified for the culture of
the merchant. Each text line should be encoded as UTF-8 and should not
contain any embedded line breaks. For more information, see section 7 of
https://tools.ietf.org/html/rfc7159
,
checkItemsData (Array[CheckItem], optional):
Gets or sets the Pay-at-Table check items (if any).
}
PayAtTableAccessFilters {
clerks (Array[PayAtTableClerk], optional):
The additional clerk(s) can be mapped to the check
}
CheckItem {
amount (number, optional):
The amount of the ordered item
,
description (string, optional):
The description
,
quantity (integer, optional):
The quantity of the item
}
PayAtTableClerk {
clerkId (string, optional):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"checkData": {
"checkNumber": "string",
"checkOpenDate": "2024-09-02T20:03:47.995Z",
"locationId": "string",
"registerId": "string",
"clerkId": "string",
"clerkCardNumber": "string",
"tableNumber": "string",
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0,
"tipBasisAmount": 0,
"accessFilters": {
"clerks": [
{
"clerkId": "string",
"clerkCardNumber": "string"
}
]
}
},
"messageData": {
"messageLine1": "string",
"messageLine2": "string"
},
"receiptData": {
"headerText": [
"string"
],
"checkItemsData": [
{
"amount": 0,
"description": "string",
"quantity": 0
}
]
},
"cultureName": "string",
"currencyCode": "string",
"inquiryRequest": "string",
"inquiryRetryCount": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/PAYATTABLE/CHECKS/QUERY
* Queries the existing Pay-at-Table checks
IMPLEMENTATION NOTES
Queries the existing Pay-at-Table checks and returns selected
(non-detailed) information for the checks in the response. This may not
be supported for all gateways depending upon the gateway integration.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
QueryPayAtTableChecksResponse {
checks (Array[PayAtTableCheckInfo]):
The Pay-at-Table checks
}
PayAtTableCheckInfo {
checkId (string):
The Pay-at-Table check identifier
,
openDateUtc (string):
The date and time for when the check was opened in Pay-at-Table in UTC in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
updateDateUtc (string, optional):
The date and time (if any) for when the check was updated in Pay-at-Table
in UTC in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
closeDateUtc (string, optional):
The date and time for when the check was closed in Pay-at-Table in UTC in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
closed (boolean):
Specifies if the check has been closed in Pay-at-Table (based on presence
of UTC close date)
,
checkRequest (PayAtTableCheckRequestData):
The Pay-at-Table check request data from the open/update check request
(also reflects data as appropriate from acknowlege/close check request)
,
checkPaymentData (PayAtTableCheckPaymentData):
The Pay-at-Table check payment data containing the current overall
payment amounts for the check
}
PayAtTableCheckRequestData {
gatewayId (string):
The gateway identifier from the open/update check request
,
industryType (string):
The industry type from the open/update check request
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
checkData (PayAtTableCheckData):
The Pay-at-Table check data from the open/update check request (also
reflects data as appropriate from acknowlege/close check request)
}
PayAtTableCheckPaymentData {
totalPaidAmount (number):
The total paid amount for the amount due on the check (does not include
total tip amount)
,
totalTipAmount (number):
The total tip amount, if any, for the check (this amount is not included
in the total paid amount)
,
totalAuthorizedAmount (number):
The total authorized amount for the check (total paid amount plus total
tip amount)
,
unpaidAmount (number, optional):
The current unpaid amount (remaining amount due) on the check (if
provided by the gateway)
}
PayAtTableCheckData {
checkNumber (string):
The client check number
,
checkOpenDate (string):
The client check open date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
locationId (string, optional):
The client location id (such as as profit center id or sales outlet id)
,
registerId (string, optional):
The client register id or terminal number
,
clerkId (string):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
,
tableNumber (string, optional):
The client table number
,
totalAmount (number):
The total amount of the check (inclusive of tax amount)
,
taxAmount (number, optional):
The tax amount, if any, of the check (this amount is included in the
total amount)
,
unpaidAmount (number):
The current unpaid amount on the check (this is the remaining amount due
on the check)
,
tipBasisAmount (number, optional):
Tip Basis Amount. If the value is set, tip amount calculation will be
based on this value
,
accessFilters (PayAtTableAccessFilters, optional):
The access filter(s), if any. This allows optional information that can
be used to classify the check(s)
}
PayAtTableAccessFilters {
clerks (Array[PayAtTableClerk], optional):
The additional clerk(s) can be mapped to the check
}
PayAtTableClerk {
clerkId (string, optional):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
}
{
"checks": [
{
"checkId": "string",
"openDateUtc": "2024-09-02T20:03:48.005Z",
"updateDateUtc": "2024-09-02T20:03:48.005Z",
"closeDateUtc": "2024-09-02T20:03:48.005Z",
"closed": true,
"checkRequest": {
"gatewayId": "string",
"industryType": "retail",
"checkData": {
"checkNumber": "string",
"checkOpenDate": "2024-09-02T20:03:48.005Z",
"locationId": "string",
"registerId": "string",
"clerkId": "string",
"clerkCardNumber": "string",
"tableNumber": "string",
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0,
"tipBasisAmount": 0,
"accessFilters": {
"clerks": [
{
"clerkId": "string",
"clerkCardNumber": "string"
}
]
}
}
},
"checkPaymentData": {
"totalPaidAmount": 0,
"totalTipAmount": 0,
"totalAuthorizedAmount": 0,
"unpaidAmount": 0
}
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The Pay-at-Table query checks request.
body
* Model
* Example Value
QueryPayAtTableChecksRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
includeClosedChecks (boolean, optional):
Specifies if closed checks should be included in the response with open
checks (default if not specified is to only include open checks)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"includeClosedChecks": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/PAYATTABLE/CHECK/{CHECKID}/QUERY
* Queries an existing Pay-at-Table check for the specified Pay-at-Table
check identifier
IMPLEMENTATION NOTES
Queries an existing Pay-at-Table check for the specified Pay-at-Table
check identifier and returns the detailed check information in the
response. This may not be supported for all gateways depending upon the
gateway integration.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
QueryPayAtTableCheckResponse {
checkId (string):
The Pay-at-Table check identifier
,
openDateUtc (string):
The date and time for when the check was opened in Pay-at-Table in UTC in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
updateDateUtc (string, optional):
The date and time (if any) for when the check was updated in Pay-at-Table
in UTC in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
closeDateUtc (string, optional):
The date and time for when the check was closed in Pay-at-Table in UTC in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
closed (boolean):
Specifies if the check has been closed in Pay-at-Table (based on presence
of UTC close date)
,
checkRequest (PayAtTableCheckRequestDetailData):
The Pay-at-Table check request data from the open/update check request
(also reflects data as appropriate from acknowlege/close check request)
,
checkPaymentData (PayAtTableCheckPaymentData):
The Pay-at-Table check payment data containing the current overall
payment amounts for the check
,
checkPaymentTransactions (Array[PayAtTableCheckPaymentTransaction]):
The Pay-at-Table check payment transactions containing the individual
payments applied to the check
,
inquiryRequest (string, optional):
The Inquiry Request
,
inquiryRetryCount (integer, optional):
The Inquiry RetryCount
}
PayAtTableCheckRequestDetailData {
requestId (string, optional):
The request identifier from the open/update check request, if any
,
gatewayId (string):
The gateway identifier from the open/update check request
,
industryType (string):
The industry type from the open/update check request
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration from the open/update check request
,
tags (Array[TagItem], optional):
The tags from the open/update check request, if any
,
checkData (PayAtTableCheckData):
The Pay-at-Table check data from the open/update check request (also
reflects data as appropriate from acknowlege/close check request)
,
messageData (PayAtTableMessageData, optional):
The Pay-at-Table message data from the open/update check request, if any
,
receiptData (PayAtTableReceiptData, optional):
The Pay-at-Table receipt data from the open/update check request, if any
,
cultureName (string, optional):
The ISO culture name from the open/update check request, if any
,
currencyCode (string, optional):
The ISO currency code from the open/update check request, if any
}
PayAtTableCheckPaymentData {
totalPaidAmount (number):
The total paid amount for the amount due on the check (does not include
total tip amount)
,
totalTipAmount (number):
The total tip amount, if any, for the check (this amount is not included
in the total paid amount)
,
totalAuthorizedAmount (number):
The total authorized amount for the check (total paid amount plus total
tip amount)
,
unpaidAmount (number, optional):
The current unpaid amount (remaining amount due) on the check (if
provided by the gateway)
}
PayAtTableCheckPaymentTransaction {
paymentId (string):
The Pay-at-Table payment identifier (unique within the scope of the
associated Pay-at-Table check identifier)
,
paymentDateUtc (string):
The payment date and time in UTC in ISO 8601 format. See
https://en.wikipedia.org/wiki/ISO_8601
,
acknowledgeDateUtc (string, optional):
The payment acknowledgement date and time (if known) in UTC in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
acknowledged (boolean, optional):
The payment acknowledgement status, if any, for the transaction (if
acknowledgement status provided by the gateway)
,
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
as reported for the transaction
,
emvInfo (EmvInfo, optional):
The EMV information, if any, required for receipt printing if receipt
data is not provided by the gateway
,
pinVerified (boolean, optional):
The PIN verified status, if any, as determined for the transaction
,
signatureStatus (string, optional):
The signature status, if any, as determined for the transaction
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
signatureData (SvgSignatureData, optional):
The signature data, if any, captured on the payment device
,
dccResponseData (DccResponseData, optional):
The DCC data, if any, applicable for the transaction. When provided, this
data must be printed on merchant and customer receipts
,
receiptData (ReceiptData, optional):
The receipt data, if any, as provided by the gateway. When provided, this
must be used for printing the merchant and customer receipts if not
printed by the device
,
transactionType (string, optional):
The payment type returned from the gateway, such as Auth, Capture and
Sale
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
PayAtTableCheckData {
checkNumber (string):
The client check number
,
checkOpenDate (string):
The client check open date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
locationId (string, optional):
The client location id (such as as profit center id or sales outlet id)
,
registerId (string, optional):
The client register id or terminal number
,
clerkId (string):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
,
tableNumber (string, optional):
The client table number
,
totalAmount (number):
The total amount of the check (inclusive of tax amount)
,
taxAmount (number, optional):
The tax amount, if any, of the check (this amount is included in the
total amount)
,
unpaidAmount (number):
The current unpaid amount on the check (this is the remaining amount due
on the check)
,
tipBasisAmount (number, optional):
Tip Basis Amount. If the value is set, tip amount calculation will be
based on this value
,
accessFilters (PayAtTableAccessFilters, optional):
The access filter(s), if any. This allows optional information that can
be used to classify the check(s)
}
PayAtTableMessageData {
messageLine1 (string, optional):
The message text for the first display line on the payment device (this
allows optional information to be displayed on the device when the check
is brought up; actual functionality depends on specific device
capability)
,
messageLine2 (string, optional):
The message text for the second display line on the payment device (this
allows optional information to be displayed on the device when the check
is brought up; actual functionality depends on specific device
capability)
}
PayAtTableReceiptData {
headerText (Array[string], optional):
The optional receipt header text that should contain the merchant's
business name, business address, and other relevant information to be
printed at the top of the receipt (however, actual functionality depends
on specific gateway and device capability including the length of lines
and any necessary wrapping of long text across lines). Note: this text
should typically be in the same language as specified for the culture of
the merchant. Each text line should be encoded as UTF-8 and should not
contain any embedded line breaks. For more information, see section 7 of
https://tools.ietf.org/html/rfc7159
,
checkItemsData (Array[CheckItem], optional):
Gets or sets the Pay-at-Table check items (if any).
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
DccResponseData {
exchangeRate (number):
The foreign currency exchange rate
,
margin (number):
The margin amount included in the exchange rate
,
foreignCurrencyAlpha (string):
The foreign currency 3 letter alpha code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyCode (string):
The foreign currency 3 digit numeric code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyAmount (number):
The foreign currency amount, e.g. the transaction amount in the foreign
currency
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
PayAtTableAccessFilters {
clerks (Array[PayAtTableClerk], optional):
The additional clerk(s) can be mapped to the check
}
CheckItem {
amount (number, optional):
The amount of the ordered item
,
description (string, optional):
The description
,
quantity (integer, optional):
The quantity of the item
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
PayAtTableClerk {
clerkId (string, optional):
The client clerk id or employee id
,
clerkCardNumber (string, optional):
The client clerk card number or employee card number
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"checkId": "string",
"openDateUtc": "2024-09-02T20:03:48.014Z",
"updateDateUtc": "2024-09-02T20:03:48.014Z",
"closeDateUtc": "2024-09-02T20:03:48.014Z",
"closed": true,
"checkRequest": {
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"checkData": {
"checkNumber": "string",
"checkOpenDate": "2024-09-02T20:03:48.014Z",
"locationId": "string",
"registerId": "string",
"clerkId": "string",
"clerkCardNumber": "string",
"tableNumber": "string",
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0,
"tipBasisAmount": 0,
"accessFilters": {
"clerks": [
{
"clerkId": "string",
"clerkCardNumber": "string"
}
]
}
},
"messageData": {
"messageLine1": "string",
"messageLine2": "string"
},
"receiptData": {
"headerText": [
"string"
],
"checkItemsData": [
{
"amount": 0,
"description": "string",
"quantity": 0
}
]
},
"cultureName": "string",
"currencyCode": "string"
},
"checkPaymentData": {
"totalPaidAmount": 0,
"totalTipAmount": 0,
"totalAuthorizedAmount": 0,
"unpaidAmount": 0
},
"checkPaymentTransactions": [
{
"paymentId": "string",
"paymentDateUtc": "2024-09-02T20:03:48.014Z",
"acknowledgeDateUtc": "2024-09-02T20:03:48.014Z",
"acknowledged": true,
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.014Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
},
"dccResponseData": {
"exchangeRate": 0,
"margin": 0,
"foreignCurrencyAlpha": "string",
"foreignCurrencyCode": "string",
"foreignCurrencyAmount": 0
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
},
"transactionType": "string"
}
],
"inquiryRequest": "string",
"inquiryRetryCount": 0
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type checkId
The Pay-at-Table check identifier.
path string request
Parameter content type: application/json text/json
The Pay-at-Table query check request.
body
* Model
* Example Value
QueryPayAtTableCheckRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/PAYATTABLE/CHECK/{CHECKID}/PAYMENTS/QUERY
* Queries the payments applied to an existing Pay-at-Table check for the
specified Pay-at-Table check identifier
IMPLEMENTATION NOTES
Queries the payments applied to an existing Pay-at-Table check for the
specified Pay-at-Table check identifier and returns the payment
information in the response.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
QueryPayAtTableCheckPaymentsResponse {
checkPaymentData (PayAtTableCheckPaymentData):
The Pay-at-Table check payment data containing the current overall
payment amounts for the check
,
checkPaymentTransactions (Array[PayAtTableCheckPaymentTransaction]):
The Pay-at-Table check payment transactions containing the individual
payments applied to the check
}
PayAtTableCheckPaymentData {
totalPaidAmount (number):
The total paid amount for the amount due on the check (does not include
total tip amount)
,
totalTipAmount (number):
The total tip amount, if any, for the check (this amount is not included
in the total paid amount)
,
totalAuthorizedAmount (number):
The total authorized amount for the check (total paid amount plus total
tip amount)
,
unpaidAmount (number, optional):
The current unpaid amount (remaining amount due) on the check (if
provided by the gateway)
}
PayAtTableCheckPaymentTransaction {
paymentId (string):
The Pay-at-Table payment identifier (unique within the scope of the
associated Pay-at-Table check identifier)
,
paymentDateUtc (string):
The payment date and time in UTC in ISO 8601 format. See
https://en.wikipedia.org/wiki/ISO_8601
,
acknowledgeDateUtc (string, optional):
The payment acknowledgement date and time (if known) in UTC in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
acknowledged (boolean, optional):
The payment acknowledgement status, if any, for the transaction (if
acknowledgement status provided by the gateway)
,
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
as reported for the transaction
,
emvInfo (EmvInfo, optional):
The EMV information, if any, required for receipt printing if receipt
data is not provided by the gateway
,
pinVerified (boolean, optional):
The PIN verified status, if any, as determined for the transaction
,
signatureStatus (string, optional):
The signature status, if any, as determined for the transaction
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
signatureData (SvgSignatureData, optional):
The signature data, if any, captured on the payment device
,
dccResponseData (DccResponseData, optional):
The DCC data, if any, applicable for the transaction. When provided, this
data must be printed on merchant and customer receipts
,
receiptData (ReceiptData, optional):
The receipt data, if any, as provided by the gateway. When provided, this
must be used for printing the merchant and customer receipts if not
printed by the device
,
transactionType (string, optional):
The payment type returned from the gateway, such as Auth, Capture and
Sale
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
DccResponseData {
exchangeRate (number):
The foreign currency exchange rate
,
margin (number):
The margin amount included in the exchange rate
,
foreignCurrencyAlpha (string):
The foreign currency 3 letter alpha code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyCode (string):
The foreign currency 3 digit numeric code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyAmount (number):
The foreign currency amount, e.g. the transaction amount in the foreign
currency
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"checkPaymentData": {
"totalPaidAmount": 0,
"totalTipAmount": 0,
"totalAuthorizedAmount": 0,
"unpaidAmount": 0
},
"checkPaymentTransactions": [
{
"paymentId": "string",
"paymentDateUtc": "2024-09-02T20:03:48.024Z",
"acknowledgeDateUtc": "2024-09-02T20:03:48.024Z",
"acknowledged": true,
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.024Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
},
"dccResponseData": {
"exchangeRate": 0,
"margin": 0,
"foreignCurrencyAlpha": "string",
"foreignCurrencyCode": "string",
"foreignCurrencyAmount": 0
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
},
"transactionType": "string"
}
]
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type checkId
The Pay-at-Table check identifier.
path string request
Parameter content type: application/json text/json
The Pay-at-Table query check payments request.
body
* Model
* Example Value
QueryPayAtTableCheckPaymentsRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/PAYATTABLE/CHECK/{CHECKID}/PAYMENTS/ACKNOWLEDGE
* Acknowledges the specified payments applied to an existing
Pay-at-Table check for the specified Pay-at-Table check identifier
IMPLEMENTATION NOTES
Acknowledges the specified payments applied to an existing Pay-at-Table
check for the specified Pay-at-Table check identifier. All payments
applied to a Pay-at-Table check must be acknowledged before the
Pay-at-Table check can be closed.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AcknowledgePayAtTableCheckPaymentsResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type checkId
The Pay-at-Table check identifier.
path string request
Parameter content type: application/json text/json
The Pay-at-Table acknowledge check payments request.
body
* Model
* Example Value
AcknowledgePayAtTableCheckPaymentsRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
paymentIds (Array[string]):
The Pay-at-Table payment identifiers.
,
totalAmount (number):
The total amount of the check (inclusive of tax amount)
,
taxAmount (number, optional):
The tax amount, if any, of the check (this amount is included in the
total amount)
,
unpaidAmount (number):
The remaining unpaid amount on the check that reflects these acknowledged
payments
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"paymentIds": [
"string"
],
"totalAmount": 0,
"taxAmount": 0,
"unpaidAmount": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/PAYATTABLE/CHECK/{CHECKID}/PAYMENTS/UPDATETRANSACTION
* Pushes payment information to an existing Pay-at-Table check for the
specified Pay-at-Table check identifier
IMPLEMENTATION NOTES
Pushes payment information to an existing Pay-at-Table check for the
specified Pay-at-Table check identifier.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
UpdatePayAtTableCheckPaymentResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type checkId
The Pay-at-Table check identifier.
path string request
Parameter content type: application/json text/json
The Pay-at-Table add payment request.
body
* Model
* Example Value
UpdatePayAtTableCheckPaymentRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
transactionId (string):
The Pay-at-Table payment identifier to be associated with the check
,
transactionType (string):
The Pay-at-Table payment type being applied
,
newTransactionAmount (number):
The new transaction amount of the check (inclusive of tax amount)
,
paymentAmount (number):
The amount of the payment to be applied on the check
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"transactionId": "string",
"transactionType": "string",
"newTransactionAmount": 0,
"paymentAmount": 0
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/PAYATTABLE/CHECK/{CHECKID}/CLOSE
* Closes an existing Pay-at-Table check for the specified Pay-at-Table
check identifier
IMPLEMENTATION NOTES
Closes an existing Pay-at-Table check for the specified Pay-at-Table
check identifier to indicate that no more payments are expected on the
check. All payments applied to a Pay-at-Table check must be acknowledged
before the Pay-at-Table check can be closed.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ClosePayAtTableCheckResponse {}
{}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type checkId
The Pay-at-Table check identifier.
path string request
Parameter content type: application/json text/json
The Pay-at-Table close check request.
body
* Model
* Example Value
ClosePayAtTableCheckRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TOKEN
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1.5/TOKEN/CREATE/DEVICE/{DEVICEGUID}
* Creates a token by using the specified payment device for card capture
and exchanging the encrypted card data for a token
IMPLEMENTATION NOTES
Creates a token by using the specified payment device for card capture
and exchanging the encrypted card data for a token.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CreateTokenResponse {
token (string):
The token value as returned by the gateway
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
cardInfo (CardInfo):
The card information, such as masked account number, card issuer, etc.,
if available
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
{
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.063Z",
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The create token request
body
* Model
* Example Value
CreateTokenOnDeviceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used
,
manualCardEntry (boolean, optional):
Specifies whether or not the device is requested to prompt for manual
card entry instead of insert/swipe/tap (if supported by the
device/gateway)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"manualCardEntry": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TOKEN/CREATE
* Creates a token by exchanging the specified encrypted card data for a
token
IMPLEMENTATION NOTES
Creates a token by exchanging the specified encrypted card data for a
token.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CreateTokenResponse {
token (string):
The token value as returned by the gateway
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
cardInfo (CardInfo):
The card information, such as masked account number, card issuer, etc.,
if available
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
{
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.070Z",
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The create token request
body
* Model
* Example Value
CreateTokenWithCardDataRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used Not used. Added
back for backward compatibility
,
encryptedCardData (EncryptedCardData):
The encrypted credit card data to exchange for a token
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TRANSACTION
* Show/Hide
* List Operations
* Expand Operations
* * POST /V1.5/TRANSACTION/SALE/BEGIN/DEVICE/{DEVICEGUID}
* Performs a begin sale transaction using the specified payment device
for card capture
IMPLEMENTATION NOTES
Performs a begin sale transaction using the specified payment device for
card capture.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
BeginSaleOnDeviceResponse {
isCardRead (boolean, optional):
The card happened or not
,
entryMode (string, optional):
The entry mode, if available
}
{
"isCardRead": true,
"entryMode": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The sale request
body
* Model
* Example Value
BeginSaleOnDeviceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a sale request
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.078Z"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/SALE/DEVICE/{DEVICEGUID}
* Performs a sale transaction using the specified payment device for
card capture
IMPLEMENTATION NOTES
Performs a sale transaction using the specified payment device for card
capture.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SaleOnDeviceResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if the transaction
was performed using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status code as returned by the gateway handler
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
signatureData (SvgSignatureData, optional):
The signature data, if any, captured on the payment device
,
dccResponseData (DccResponseData, optional):
The DCC data to be printed on a sales receipt if applicable for this
transaction. When provided, this data must be printed on merchant and
customer receipts
,
isOfflineApproved (boolean, optional):
Specifies if the transaction is offline or online
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
DccResponseData {
exchangeRate (number):
The foreign currency exchange rate
,
margin (number):
The margin amount included in the exchange rate
,
foreignCurrencyAlpha (string):
The foreign currency 3 letter alpha code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyCode (string):
The foreign currency 3 digit numeric code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyAmount (number):
The foreign currency amount, e.g. the transaction amount in the foreign
currency
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.083Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
},
"dccResponseData": {
"exchangeRate": 0,
"margin": 0,
"foreignCurrencyAlpha": "string",
"foreignCurrencyCode": "string",
"foreignCurrencyAmount": 0
},
"isOfflineApproved": true,
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The sale request
body
* Model
* Example Value
SaleOnDeviceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a sale request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a sale request
,
lodgingData (LodgingData, optional):
Lodging data for a sale request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
,
tipPromptData (TipPromptData, optional):
If specified, the tip prompt data for a sale request will be used to
prompt the guest for a tip on the payment device. If not specified, the
guest will not be prompted for a tip
,
promptForSignature (boolean, optional):
Specifies whether the device will prompt the guest for a signature or not
(if not specified, defaults to true)
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device (if not specified, the default culture is used)
,
offline (boolean, optional):
Specifies whether or not the transaction is requested to be handled as
offline (if supported by the device/gateway)
,
manualCardEntry (boolean, optional):
Specifies whether or not the device is requested to prompt for manual
card entry instead of insert/swipe/tap (if supported by the
device/gateway)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
TipPromptData {
tipSeedAmount (number, optional):
If specified, this amount is "seeded" as the suggested tip amount on the
device
,
tipPresetValueType (string):
Specifies the tip preset type to be used, if available, on the device
= ['none', 'amount', 'percent']
stringEnum:"none", "amount", "percent"
,
tipPreset1 (number, optional):
The first tip preset value
,
tipPreset2 (number, optional):
The second tip preset value
,
tipPreset3 (number, optional):
The third tip preset value
,
tipPreset4 (number, optional):
The fourth tip preset value
,
tipBasisAmount (number, optional):
Tip Basis Amount. If the value is set, tip amount calculation will be
based on this value.
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.087Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.087Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.087Z",
"checkOutDate": "2024-09-02T20:03:48.087Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"tipPromptData": {
"tipSeedAmount": 0,
"tipPresetValueType": "none",
"tipPreset1": 0,
"tipPreset2": 0,
"tipPreset3": 0,
"tipPreset4": 0,
"tipBasisAmount": 0
},
"promptForSignature": true,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"offline": true,
"manualCardEntry": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/SALE/TOKEN/{TOKEN}
* Performs a sale transaction using the specified card token
IMPLEMENTATION NOTES
Performs a sale transaction using the specified card token.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SaleResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.100Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token
The card token
path string request
Parameter content type: application/json text/json
The sale request
body
* Model
* Example Value
SaleRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a sale request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a sale request
,
lodgingData (LodgingData, optional):
Lodging data for a sale request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.101Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.101Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.101Z",
"checkOutDate": "2024-09-02T20:03:48.101Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/SALE
* Performs a sale transaction using the specified encrypted card data
IMPLEMENTATION NOTES
Performs a sale transaction using the specified encrypted card data.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
SaleResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.114Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The sale request
body
* Model
* Example Value
SaleWithCardDataRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a sale request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a sale request
,
lodgingData (LodgingData, optional):
Lodging data for a sale request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
,
encryptedCardData (EncryptedCardData):
The encrypted credit card data
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.115Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.115Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.115Z",
"checkOutDate": "2024-09-02T20:03:48.115Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH/DEVICE/{DEVICEGUID}
* Performs an authorization transaction using the specified payment
device for card capture
IMPLEMENTATION NOTES
Performs an authorization transaction using the specified payment device
for card capture.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthOnDeviceResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if the transaction
was performed using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status code as returned by the gateway handler
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
signatureData (SvgSignatureData, optional):
The signature data, if any, captured on the payment device
,
dccResponseData (DccResponseData, optional):
The DCC data to be printed on a sales receipt if applicable for this
transaction. When provided, this data must be printed on merchant and
customer receipts
,
isOfflineApproved (boolean, optional):
Specifies if the transaction is offline or online
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
DccResponseData {
exchangeRate (number):
The foreign currency exchange rate
,
margin (number):
The margin amount included in the exchange rate
,
foreignCurrencyAlpha (string):
The foreign currency 3 letter alpha code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyCode (string):
The foreign currency 3 digit numeric code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyAmount (number):
The foreign currency amount, e.g. the transaction amount in the foreign
currency
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.125Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
},
"dccResponseData": {
"exchangeRate": 0,
"margin": 0,
"foreignCurrencyAlpha": "string",
"foreignCurrencyCode": "string",
"foreignCurrencyAmount": 0
},
"isOfflineApproved": true,
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The auth request
body
* Model
* Example Value
AuthOnDeviceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth request
,
transactionData (TransactionPaymentData):
Transaction data for an auth request
,
lodgingData (LodgingData, optional):
Lodging data for an auth request, if applicable
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the authorization as online. An
auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is
based on a prior transaction id
,
promptForSignature (boolean, optional):
Specifies whether the device will prompt the guest for a signature or not
(if not specified, defaults to true)
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used
,
offline (boolean, optional):
Specifies whether or not the transaction is requested to be handled as
offline (if supported by the device/gateway)
,
manualCardEntry (boolean, optional):
Specifies whether or not the device is requested to prompt for manual
card entry instead of insert/swipe/tap (if supported by the
device/gateway)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.128Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.128Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.128Z",
"checkOutDate": "2024-09-02T20:03:48.128Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"promptForSignature": true,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"offline": true,
"manualCardEntry": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH/TOKEN/{TOKEN}
* Performs a an authorization transaction using the specified card token
IMPLEMENTATION NOTES
Performs a an authorization transaction using the specified card token.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.140Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token
The card token
path string request
Parameter content type: application/json text/json
The auth request
body
* Model
* Example Value
AuthRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth request
,
transactionData (TransactionPaymentData):
Transaction data for an auth request
,
lodgingData (LodgingData, optional):
Lodging data for an auth request, if applicable
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the authorization as online. An
auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is
based on a prior transaction id
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.141Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.141Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.141Z",
"checkOutDate": "2024-09-02T20:03:48.141Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH
* Performs an authorization transaction using the specified encrypted
card data
IMPLEMENTATION NOTES
Performs an authorization transaction using the specified encrypted card
data.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.154Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The auth request
body
* Model
* Example Value
AuthWithCardDataRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth request
,
transactionData (TransactionPaymentData):
Transaction data for an auth request
,
lodgingData (LodgingData, optional):
Lodging data for an auth request, if applicable
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the authorization as online. An
auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is
based on a prior transaction id
,
encryptedCardData (EncryptedCardData):
The encrypted credit card data
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.155Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.155Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.155Z",
"checkOutDate": "2024-09-02T20:03:48.155Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH/TRANSACTION/STATE
* Performs an authorization transaction using the specified transaction
state from a prior offline transaction
IMPLEMENTATION NOTES
Performs an authorization transaction using the specified transaction
state from a prior offline transaction.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.166Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The auth request
body
* Model
* Example Value
AuthWithTransactionStateRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth request
,
transactionData (TransactionPaymentData):
Transaction data for an auth request
,
lodgingData (LodgingData, optional):
Lodging data for an auth request, if applicable
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is true if request uses a device or request contains encrypted credit
card data)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is true if request uses a device or request contains encrypted
credit card data)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the authorization as online. An
auth code must not be provided to perform a typical online authorization.
The auth code is ignored if the transaction is EMV or the transaction is
based on a prior transaction id
,
transactionState (string):
The transaction state returned from a previous offline transaction
response
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.167Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.167Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.167Z",
"checkOutDate": "2024-09-02T20:03:48.167Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"transactionState": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH/INCREASE/TRANSACTION/{TRANSACTIONID}
* Increases a previously obtained authorization for the specified
transaction identifier
IMPLEMENTATION NOTES
Increases a previously obtained authorization for the specified
transaction identifier (lodging only).
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthIncreaseResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.183Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId
The transaction identifier
path string request
Parameter content type: application/json text/json
The auth increase request
body
* Model
* Example Value
AuthIncreaseRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth increase request
,
transactionData (TransactionAuthIncreaseData):
Transaction data for an auth increase request
,
lodgingData (LodgingData, optional):
Lodging data for an auth increase request
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if returned from the gateway, from a
prior transaction
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionAuthIncreaseData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
incrementalTransactionAmount (number):
The incremental amount of the authorization increase (this is the amount
by which to increase the authorization)
,
incrementalTaxAmount (number, optional):
The tax amount, if any, of the incremental transaction amount (this
amount is included in the incremental amount)
,
newTransactionAmount (number):
The new total amount of the authorization, inclusive of the incremental
transaction amount
,
newTaxAmount (number, optional):
The tax amount, if any, of the new total authorization amount (this
amount is included in the new transaction amount)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.185Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.185Z",
"referenceCode": "string",
"incrementalTransactionAmount": 0,
"incrementalTaxAmount": 0,
"newTransactionAmount": 0,
"newTaxAmount": 0
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.185Z",
"checkOutDate": "2024-09-02T20:03:48.185Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH/DECREASE/TRANSACTION/{TRANSACTIONID}
* Decreases a previously obtained authorization for the specified
transaction identifier
IMPLEMENTATION NOTES
Decreases a previously obtained authorization for the specified
transaction identifier (lodging only).
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthDecreaseResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.199Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId
The transaction identifier.
path string request
Parameter content type: application/json text/json
The auth decrease request.
body
* Model
* Example Value
AuthDecreaseRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth decrease request
,
transactionData (TransactionAuthDecreaseData):
Transaction data for an auth decrease request
,
lodgingData (LodgingData, optional):
Lodging data for an auth decrease request
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if returned from the gateway, from a
prior transaction
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionAuthDecreaseData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
originalTransactionAmount (number):
The original authorization amount
,
newTransactionAmount (number):
The new total amount of the authorization (the decreased transaction
amount)
,
newTaxAmount (number):
The tax amount, if any, of the new total authorization amount (this
amount is included in the new transaction amount)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.201Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.201Z",
"referenceCode": "string",
"originalTransactionAmount": 0,
"newTransactionAmount": 0,
"newTaxAmount": 0
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.201Z",
"checkOutDate": "2024-09-02T20:03:48.201Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/AUTH/REVERSAL/TRANSACTION/{TRANSACTIONID}
* Reverses or voids a previously obtained credit card authorization
IMPLEMENTATION NOTES
Reverses or voids a previously obtained credit card authorization.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
AuthReversalResponse {
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId
The transaction identifier.
path string request
Parameter content type: application/json text/json
The auth reversal request.
body
* Model
* Example Value
AuthReversalRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for an auth increase request
,
transactionData (TransactionAuthReversalData):
Transaction data for an auth reversal request
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if returned from the gateway, from a
prior transaction
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionAuthReversalData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
originalTransactionAmount (number):
The original authorization amount
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.213Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.213Z",
"referenceCode": "string",
"originalTransactionAmount": 0
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
501
NotImplemented
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/CAPTURE/TRANSACTION/{TRANSACTIONID}
* Captures a previous authorization for the specified transaction
identifier
IMPLEMENTATION NOTES
Captures a previous authorization for the specified transaction
identifier.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CaptureResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
dccResponseData (DccResponseData, optional):
The DCC data to be printed on a sales receipt if applicable for this
transaction. When provided, this data must be printed on merchant and
customer receipts
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
DccResponseData {
exchangeRate (number):
The foreign currency exchange rate
,
margin (number):
The margin amount included in the exchange rate
,
foreignCurrencyAlpha (string):
The foreign currency 3 letter alpha code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyCode (string):
The foreign currency 3 digit numeric code as defined by ISO-4217. See
https://en.wikipedia.org/wiki/ISO_4217
,
foreignCurrencyAmount (number):
The foreign currency amount, e.g. the transaction amount in the foreign
currency
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.226Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"dccResponseData": {
"exchangeRate": 0,
"margin": 0,
"foreignCurrencyAlpha": "string",
"foreignCurrencyCode": "string",
"foreignCurrencyAmount": 0
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId
The transaction identifier
path string request
Parameter content type: application/json text/json
The capture request
body
* Model
* Example Value
CaptureRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a capture request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a capture request
,
lodgingData (LodgingData, optional):
Lodging data for a capture request
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionState (string, optional):
The transaction state, if returned from the gateway, from a prior
authorization transaction
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if returned from the gateway, from a
prior transaction
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.227Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.227Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.227Z",
"checkOutDate": "2024-09-02T20:03:48.227Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionState": "string",
"transactionFollowOnData": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/FORCECAPTURE/TOKEN/{TOKEN}
* Captures a verbal or offline authorization using the specified token
IMPLEMENTATION NOTES
Captures a verbal or offline authorization using the specified token.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ForceCaptureResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.237Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token
The card token
path string request
Parameter content type: application/json text/json
The force capture request
body
* Model
* Example Value
ForceCaptureRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a force capture request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a force capture request
,
lodgingData (LodgingData, optional):
Lodging data for a force capture request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the force capture as offline
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.240Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.240Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.240Z",
"checkOutDate": "2024-09-02T20:03:48.240Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/FORCECAPTURE
* Captures a verbal or offline authorization using the specified
encrypted card data
IMPLEMENTATION NOTES
Captures a verbal or offline authorization using the specified encrypted
card data.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ForceCaptureResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.250Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The force capture request
body
* Model
* Example Value
ForceCaptureWithCardDataRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a force capture request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a force capture request
,
lodgingData (LodgingData, optional):
Lodging data for a force capture request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the force capture as offline
,
encryptedCardData (EncryptedCardData):
The encrypted credit card data
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.251Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.251Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.251Z",
"checkOutDate": "2024-09-02T20:03:48.251Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/FORCECAPTURE/TRANSACTION/STATE
* Captures a verbal or offline authorization using the specified
transaction state
IMPLEMENTATION NOTES
Captures a verbal or offline authorization using the specified
transaction state.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
ForceCaptureResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.263Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The force capture request
body
* Model
* Example Value
ForceCaptureWithTransactionStateRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a force capture request
,
transactionData (TransactionPaymentCaptureData):
Transaction data for a force capture request
,
lodgingData (LodgingData, optional):
Lodging data for a force capture request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
authCode (string, optional):
The verbal authorization code from the authorization center, if provided.
If none provided, the gateway will treat the force capture as offline
,
transactionState (string):
The transaction state returned from a previous offline transaction
response
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentCaptureData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
tipAmount (number, optional):
The tip amount, if any, for this request (this amount or a tip captured
on the payment device is added to the transaction amount before the
cardholder is charged)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.264Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.265Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.265Z",
"checkOutDate": "2024-09-02T20:03:48.265Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"authCode": "string",
"transactionState": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/REFUND/TRANSACTION/{TRANSACTIONID}
* Refunds a previously captured transaction for the specified
transaction identifier
IMPLEMENTATION NOTES
Refunds a previously captured transaction for the specified transaction
identifier.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
RefundResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.282Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId
The transaction identifier
path string request
Parameter content type: application/json text/json
The refund request
body
* Model
* Example Value
RefundRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a refund request
,
transactionData (TransactionPaymentData):
Transaction data for a refund request
,
lodgingData (LodgingData, optional):
Lodging data for a refund request
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if returned from the gateway, from a
prior transaction
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.284Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.284Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.284Z",
"checkOutDate": "2024-09-02T20:03:48.284Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/CREDIT/DEVICE/{DEVICEGUID}
* Performs a credit transaction using the specified payment device for
card capture
IMPLEMENTATION NOTES
Performs a credit transaction using the specified payment device for card
capture.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CreditOnDeviceResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if the transaction
was performed using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status code as returned by the gateway handler
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
signatureData (SvgSignatureData, optional):
The signature data, if any, captured on the payment device
,
isOfflineApproved (boolean, optional):
Specifies if the transaction is offline or online
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
SvgSignatureData {
format (string):
The signature format
,
height (integer):
The height
,
width (integer):
The width
,
polyLines (Array[SvgPolyLine]):
The poly lines
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
SvgPolyLine {
points (Array[SvgPoint]):
The SVG points
}
SvgPoint {
x (integer):
The X coordinate
,
y (integer):
The Y coordinate
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.293Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"signatureData": {
"format": "string",
"height": 0,
"width": 0,
"polyLines": [
{
"points": [
{
"x": 0,
"y": 0
}
]
}
]
},
"isOfflineApproved": true,
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type deviceGuid
The unique identifier of the device
path string request
Parameter content type: application/json text/json
The credit request
body
* Model
* Example Value
CreditOnDeviceRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a credit request
,
transactionData (TransactionPaymentData):
Transaction data for a credit request
,
lodgingData (LodgingData, optional):
Lodging data for a credit request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
promptForSignature (boolean, optional):
Specifies whether the device will prompt the guest for a signature or not
(if not specified, defaults to true)
,
currencyCulture (CurrencyCulture, optional):
Client culture to use when displaying currency amounts on a display
device, if not specified, the default culture is used
,
manualCardEntry (boolean, optional):
Specifies whether or not the device is requested to prompt for manual
card entry instead of insert/swipe/tap (if supported by the
device/gateway)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
CurrencyCulture {
currencyCultureName (string, optional):
The currency culture name (e.g. "en-US", "en-GB", "fr-FR")
,
currencySymbol (string, optional):
The currency symbol (e.g. "$", "£", "€"); if specified, this value
overrides the currency symbol determined by current service culture
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.295Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.295Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.295Z",
"checkOutDate": "2024-09-02T20:03:48.295Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"promptForSignature": true,
"currencyCulture": {
"currencyCultureName": "string",
"currencySymbol": "string"
},
"manualCardEntry": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/CREDIT/TOKEN/{TOKEN}
* Performs a credit transaction using the specified card token
IMPLEMENTATION NOTES
Performs a credit transaction using the specified card token.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CreditResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.309Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token
The card token
path string request
Parameter content type: application/json text/json
The credit request
body
* Model
* Example Value
CreditRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a credit request
,
transactionData (TransactionPaymentData):
Transaction data for a credit request
,
lodgingData (LodgingData, optional):
Lodging data for a credit request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.312Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.312Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.312Z",
"checkOutDate": "2024-09-02T20:03:48.312Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/CREDIT
* Performs a credit transaction using the specified encrypted card data
IMPLEMENTATION NOTES
Performs a credit transaction using the specified encrypted card data.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CreditResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.325Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The credit request
body
* Model
* Example Value
CreditWithCardDataRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a credit request
,
transactionData (TransactionPaymentData):
Transaction data for a credit request
,
lodgingData (LodgingData, optional):
Lodging data for a credit request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
encryptedCardData (EncryptedCardData):
The encrypted credit card data
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
EncryptedCardData {
deviceType (string, optional):
The device type identifier as reported by the device, if any, e.g.
ingenico, idtechkb, etc.
,
entryMode (string, optional):
The card entry mode as reported by the device, if any, e.g. swiped,
keyed, etc.
,
encryptionMode (string, optional):
The encryption mode, e.g. onguard, tdes, etc. as reported by the device,
if any
,
encryptionKeySerialNumber (string, optional):
The encryption key serial number as reported by the device, if any
,
encryptedData (string, optional):
The encrypted card data as reported by the device, if any
,
encryptedTrack1 (string, optional):
Th encrypted track 1 data reported by the device, if any
,
encryptedTrack1Length (integer, optional):
The encrypted track 1 data length reported by the device, if any
,
encryptedTrack2 (string, optional):
The encrypted track 2 data as reported by the device, if any
,
encryptedTrack2Length (integer, optional):
The encrypted track 2 data length reported by the device, if any
,
cardHolderName (string, optional):
The cardholder name as reported by the device, if any. If only encrypted
track 2 is provided, there will not be cardholder name in that track
(because encrypted track 1 would be the track to contain cardholder name)
and cardholder name should be provided in this field if available. If
encrypted data is provided, it is possible (depending on the device) that
cardholder name is contained in the encrypted data.
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.326Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.326Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.326Z",
"checkOutDate": "2024-09-02T20:03:48.326Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"encryptedCardData": {
"deviceType": "string",
"entryMode": "string",
"encryptionMode": "string",
"encryptionKeySerialNumber": "string",
"encryptedData": "string",
"encryptedTrack1": "string",
"encryptedTrack1Length": 0,
"encryptedTrack2": "string",
"encryptedTrack2Length": 0,
"cardHolderName": "string"
}
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/CREDIT/TRANSACTION/STATE
* Performs a credit transaction using the specified transaction state
from a prior offline transaction
IMPLEMENTATION NOTES
Performs a credit transaction using the specified transaction state from
a prior offline transaction.
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
CreditResponse {
transactionReferenceData (TransactionReferenceData):
The transaction reference data a client may use to refer to previous
transactions
,
transactionResponseData (TransactionPaymentResponseData):
The transaction response data containing the transaction amounts
,
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc. if
the transaction was performed using card capture on a payment device
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
TransactionReferenceData {
transactionId (string):
The transaction identifier
,
token (string, optional):
The transaction token
,
tokenExpirationDate (string, optional):
The token expiration date and time, if available from the gateway, as UTC
in ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
,
transactionState (string, optional):
The transaction state, if any, that must be passed in a subsequent
follow-on transaction. Unlike offline transaction state, the transaction
state from an online response does not contain data that must be purged
per PCI requirements (e.g. only EMV chip data required for capture) but
purging the transaction state is still recommended after the follow-on
transaction is completed
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if any, that must be passed in a
subsequent follow-on transaction
,
complianceDataValue (string, optional):
The compliance data value returned by gateway for COF transactions Elavon
API response field :0738
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"transactionReferenceData": {
"transactionId": "string",
"token": "string",
"tokenExpirationDate": "2024-09-02T20:03:48.340Z",
"transactionState": "string",
"transactionFollowOnData": "string",
"complianceDataValue": "string"
},
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type request
Parameter content type: application/json text/json
The credit request
body
* Model
* Example Value
CreditWithTransactionStateRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a credit request
,
transactionData (TransactionPaymentData):
Transaction data for a credit request
,
lodgingData (LodgingData, optional):
Lodging data for a credit request
,
billingAddress (AddressData, optional):
Customer billing address, if applicable
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionState (string):
The transaction state returned from a previous offline transaction
response
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionPaymentData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
,
transactionAmount (number):
The transaction amount for this request (inclusive of tax amount but not
tip amount)
,
taxAmount (number, optional):
The tax amount, if any, for this transaction (this amount is included in
the transaction amount)
,
surchargeAmount (number, optional):
The surcharge amount, if any, for this transaction (this amount is added
to the transaction amount before the cardholder is charged)
,
allowPartialTransactionAmount (boolean, optional):
Specifies whether the client can accept partial authorizations or not (if
not specified, default is true)
}
LodgingData {
folioNumber (string, optional):
The folio number of the guest (required if chargeType is other than
"backOffice")
,
guestName (string, optional):
The name of the guest (required if chargeType is other than "backOffice")
,
checkInDate (string, optional):
The check-in date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
checkOutDate (string, optional):
The check-out date for the guest in the client's time zone in ISO 8601
format (required if chargeType is other than "backOffice"). See
https://en.wikipedia.org/wiki/ISO_8601
,
expectedDuration (integer, optional):
The expected stay duration in days for the guest (value must be greater
than zero and is required if chargeType is other than "backOffice")
,
chargeType (string, optional):
The charge type (default value is "lodging" if not provided)
= ['lodging', 'restaurant', 'giftShop', 'other', 'backOffice']
stringEnum:"lodging", "restaurant", "giftShop", "other", "backOffice"
,
chargeCode (string, optional):
The charge code (default value is "default" if not provided)
= ['default', 'advanceDeposit', 'delayedCharge']
stringEnum:"default", "advanceDeposit", "delayedCharge"
,
noShow (boolean, optional):
Indicates the guest was a "no-show" (default value is false if not
provided)
,
roomNumber (string, optional):
The room number of the guest
,
dailyRoomRate (number, optional):
The daily room rate (value must be greater than zero and is required if
chargeType is other than "backOffice")
,
dailyRoomTax (number, optional):
The daily room tax (default value is zero if not provided)
,
extraChargesTotalAmount (number, optional):
The total amount of extra charges, if any
,
extraChargesTypes (Array[string], optional):
The types of extra charges, if any (default value is "other" if not
provided but extra charges total amount provided) = ['restaurant',
'giftShop', 'telephone', 'minibar', 'laundry', 'other']
}
AddressData {
firstName (string, optional):
The account holder's first name, if any
,
middleName (string, optional):
The account holder's middle name, if any
,
lastName (string, optional):
The account holder's last name, if any
,
addressLine1 (string, optional):
The first line of the street address, if any
,
addressLine2 (string, optional):
The second line of the street address, if any
,
city (string, optional):
The city, if any
,
state (string, optional):
The state or province, if any
,
postalCode (string, optional):
The zip or postal code, if any
,
country (string, optional):
The 3-character IS0-3166-1 country code (e.g. USA, GBR, DEU etc.). See
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3
,
phoneNumber (string, optional):
The phone number, if any
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.341Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.341Z",
"referenceCode": "string",
"transactionAmount": 0,
"taxAmount": 0,
"surchargeAmount": 0,
"allowPartialTransactionAmount": true
},
"lodgingData": {
"folioNumber": "string",
"guestName": "string",
"checkInDate": "2024-09-02T20:03:48.341Z",
"checkOutDate": "2024-09-02T20:03:48.341Z",
"expectedDuration": 0,
"chargeType": "lodging",
"chargeCode": "default",
"noShow": true,
"roomNumber": "string",
"dailyRoomRate": 0,
"dailyRoomTax": 0,
"extraChargesTotalAmount": 0,
"extraChargesTypes": [
"restaurant"
]
},
"billingAddress": {
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"phoneNumber": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"transactionState": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
402
PaymentRequired
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /V1.5/TRANSACTION/VOID/TRANSACTION/{TRANSACTIONID}
* Voids a transaction for the specified transaction identifier
IMPLEMENTATION NOTES
Void a sale, capture, force capture, refund, or credit for the specified
transaction identifier. To void an authorization, use /auth/reversal
RESPONSE CLASS (STATUS 200)
OK
* Model
* Example Value
VoidResponse {
gatewayResponseData (GatewayResponseData):
The gateway specific response data from the gateway vendor
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
{
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId
The transaction identifier
path string request
Parameter content type: application/json text/json
The void request
body
* Model
* Example Value
VoidRequest {
requestId (string, optional):
The request identifier, if any. This is an optional client-generated GUID
that may be logged or stored with the request
,
gatewayId (string):
The gateway identifier. This indicates to rGuest Pay the gateway handler
that should be used to process the request
,
industryType (string):
The industry type, if any. If not specified, the gateway handler will
default to the merchant configuration in the gateway
= ['retail', 'foodAndBeverage', 'lodging', 'eCommerce']
stringEnum:"retail", "foodAndBeverage", "lodging", "eCommerce"
,
configuration (Array[ConfigurationItem], optional):
The configuration, if any. This may be required depending on the
particular request and gateway identifier
,
tags (Array[TagItem], optional):
The tags, if any. This is an optional collection of client-specified tags
that may be logged or stored with the request
,
storedCredential (StoredCredentialItem, optional):
StoredCredential
,
invoiceData (InvoiceData):
Invoice data for a void request
,
transactionData (TransactionData):
Transaction data for a void request
,
cardPresent (boolean, optional):
Specifies whether the card is present or not (if not specified, default
is false)
,
cardholderPresent (boolean, optional):
Specifies whether the cardholder is present or not (if not specified,
default is false)
,
transactionFollowOnData (string, optional):
The transaction follow-on data, if returned from the gateway, from a
prior transaction
}
ConfigurationItem {
key (string):
The configuration key
,
value (string, optional):
The configuration value
}
TagItem {
key (string):
The tag key
,
value (string, optional):
The tag value
}
StoredCredentialItem {
transactionType (string, optional):
The COF Transaction Type
= ['recurringInitial', 'recurringSubsequent', 'recurringResubmission',
'instalmentInitial', 'instalmentSubsequent', 'instalmentResubmission',
'merchantInitiatedIncrementalAuth', 'merchantInitiatedInitial',
'merchantInitiatedSubsequent', 'merchantInitiatedResubmission',
'cardHolderInitiatedInitial', 'cardHolderInitiatedSubsequent',
'cardHolderInitiatedResubmission', 'reAuthorization', 'noShow',
'delayedCharge', 'unscheduledCOFInitial', 'unscheduledCOFSubsequent']
stringEnum:"recurringInitial", "recurringSubsequent",
"recurringResubmission", "instalmentInitial", "instalmentSubsequent",
"instalmentResubmission", "merchantInitiatedIncrementalAuth",
"merchantInitiatedInitial", "merchantInitiatedSubsequent",
"merchantInitiatedResubmission", "cardHolderInitiatedInitial",
"cardHolderInitiatedSubsequent", "cardHolderInitiatedResubmission",
"reAuthorization", "noShow", "delayedCharge", "unscheduledCOFInitial",
"unscheduledCOFSubsequent"
,
numberOfInstalments (integer, optional):
The total number of instalments when the transaction is part of an
instalment payment
,
instalmentNumber (integer, optional):
The installment number out of the total number of instalments.
,
complianceDatavalue (string, optional):
The COF value returned by the gateway, This should be provided for all
subsequent COF transactions
}
InvoiceData {
invoiceId (string):
The client invoice identifier or check identifier
,
invoiceDate (string):
The client invoice or check date and time in the client's time zone in
ISO 8601 format. See https://en.wikipedia.org/wiki/ISO_8601
}
TransactionData {
registerId (string, optional):
The client register id or terminal number
,
clerkId (string, optional):
The client clerk id or employee id
,
transactionDate (string):
The transaction date and time in the client's time zone in ISO 8601
format. See https://en.wikipedia.org/wiki/ISO_8601
,
referenceCode (string, optional):
A client-generated reference code that is sent to the gateway and
returned back in the response
}
{
"requestId": "00000000-0000-0000-0000-000000000000",
"gatewayId": "string",
"industryType": "retail",
"configuration": [
{
"key": "string",
"value": "string"
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"storedCredential": {
"transactionType": "recurringInitial",
"numberOfInstalments": 0,
"instalmentNumber": 0,
"complianceDatavalue": "string"
},
"invoiceData": {
"invoiceId": "string",
"invoiceDate": "2024-09-02T20:03:48.354Z"
},
"transactionData": {
"registerId": "string",
"clerkId": "string",
"transactionDate": "2024-09-02T20:03:48.354Z",
"referenceCode": "string"
},
"cardPresent": true,
"cardholderPresent": true,
"transactionFollowOnData": "string"
}
RESPONSE MESSAGES
HTTP Status Code Reason Response Model Headers 400
BadRequest
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
404
NotFound
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
409
Conflict
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
500
InternalServerError
* Model
* Example Value
ErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
]
}
502
BadGateway
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
504
GatewayTimeout
* Model
* Example Value
GatewayErrorResponse {
code (integer, read only):
The rGuest Pay numeric error code
,
reason (string):
The rGuest Pay error reason
= ['clientInvalidRequest', 'clientInvalidConfiguration',
'clientInvalidDeviceGuid', 'clientInvalidTransactionId',
'clientInvalidToken', 'clientInvalidTransactionState',
'clientInvalidTransactionFollowOnData', 'clientInvalidPayAtTableCheckId',
'clientAbortedRequest', 'serverError', 'serverUnsupportedRequest',
'serverInvalidConfiguration', 'deviceError',
'deviceInvalidConfiguration', 'deviceNotAvailable', 'deviceNotReady',
'deviceOperationUnsupported', 'deviceOperationAborted',
'deviceReadWithoutPrompt', 'deviceNoDataAvailable', 'deviceInvalidData',
'deviceUserPressedCancel', 'deviceUserInputTimeout', 'gatewayError',
'gatewayAuthenticationFailed', 'gatewayUnavailable',
'gatewayProcessorUnavailable', 'gatewayUnsupportedRequest',
'transactionError', 'transactionNotFound', 'transactionInvalidState',
'transactionDuplicate', 'cardError', 'cardErrorUnsupportedCardType',
'cardErrorInvalidAccountNumber', 'cardErrorInvalidExpirationDate',
'cardErrorUnsupportedCardIssuer', 'cardErrorChipError',
'cardErrorUnsupportedTransactionForCardType', 'cardDeclined',
'cardDeclinedExpired', 'cardDeclinedLimit', 'cardDeclinedReferral',
'cardDeclinedCvv', 'cardDeclinedAvs', 'cardDeclinedChipDecline',
'payAtTableError', 'payAtTableCheckNotFound',
'payAtTableCheckAlreadyExists', 'payAtTableCheckPaymentNotFound',
'payAtTableCheckUnacknowledgedPayments', 'payAtTableCheckAlreadyClosed',
'offlineTransactionNotReachedToGateway',
'offlineTransactionNotApprovedByGateway', 'offlineFloorLimitExceeded']
stringEnum:"clientInvalidRequest", "clientInvalidConfiguration",
"clientInvalidDeviceGuid", "clientInvalidTransactionId",
"clientInvalidToken", "clientInvalidTransactionState",
"clientInvalidTransactionFollowOnData", "clientInvalidPayAtTableCheckId",
"clientAbortedRequest", "serverError", "serverUnsupportedRequest",
"serverInvalidConfiguration", "deviceError",
"deviceInvalidConfiguration", "deviceNotAvailable", "deviceNotReady",
"deviceOperationUnsupported", "deviceOperationAborted",
"deviceReadWithoutPrompt", "deviceNoDataAvailable", "deviceInvalidData",
"deviceUserPressedCancel", "deviceUserInputTimeout", "gatewayError",
"gatewayAuthenticationFailed", "gatewayUnavailable",
"gatewayProcessorUnavailable", "gatewayUnsupportedRequest",
"transactionError", "transactionNotFound", "transactionInvalidState",
"transactionDuplicate", "cardError", "cardErrorUnsupportedCardType",
"cardErrorInvalidAccountNumber", "cardErrorInvalidExpirationDate",
"cardErrorUnsupportedCardIssuer", "cardErrorChipError",
"cardErrorUnsupportedTransactionForCardType", "cardDeclined",
"cardDeclinedExpired", "cardDeclinedLimit", "cardDeclinedReferral",
"cardDeclinedCvv", "cardDeclinedAvs", "cardDeclinedChipDecline",
"payAtTableError", "payAtTableCheckNotFound",
"payAtTableCheckAlreadyExists", "payAtTableCheckPaymentNotFound",
"payAtTableCheckUnacknowledgedPayments", "payAtTableCheckAlreadyClosed",
"offlineTransactionNotReachedToGateway",
"offlineTransactionNotApprovedByGateway", "offlineFloorLimitExceeded"
,
message (string):
The error message, suitable for display in a client user interface
,
debugMessage (string, optional):
The debug message, suitable for logging
,
validationErrors (Array[ValidationError], optional):
The validation errors, if any
,
transactionState (string, optional):
The offline transaction state, if any, that can be used to perform an
online transaction. Since the transaction state may contain encrypted
card data, any transaction state that is stored by the client must be
purged per PCI requirements after the online transaction has been
completed
,
transactionResponseData (TransactionPaymentResponseData, optional):
The transaction response data, if any when transaction state is present,
containing the attempted transaction amounts
,
gatewayResponseData (GatewayResponseData, optional):
The gateway response data, if available
,
cardInfo (CardInfo, optional):
The card information, such as masked account number, card issuer, etc.,
if available
,
emvInfo (EmvInfo, optional):
The EMV information, necessary for receipt printing, if a transaction was
attempted using an EMV card on a payment device
,
pinVerified (boolean, optional):
Specifies if the card was verified by a PIN, if a transaction was
attempted using an EMV card on a payment device
,
signatureStatus (string, optional):
The signature status, if a transaction was attempted using an EMV card on
a payment device
= ['unknown', 'signaturePresent', 'signatureNotPresent',
'signatureRequired', 'signatureRequiredCancelledByCardholder',
'signatureRequiredNotSupportedByDevice',
'singatureRequiredPinDeviceError', 'signatureNotRequired',
'signatureNotRequiredByThresholdAmount',
'signatureNotRequiredByPaymentType',
'signatureNotRequiredByTransactionType']
stringEnum:"unknown", "signaturePresent", "signatureNotPresent",
"signatureRequired", "signatureRequiredCancelledByCardholder",
"signatureRequiredNotSupportedByDevice",
"singatureRequiredPinDeviceError", "signatureNotRequired",
"signatureNotRequiredByThresholdAmount",
"signatureNotRequiredByPaymentType",
"signatureNotRequiredByTransactionType"
,
receiptData (ReceiptData, optional):
The receipt data, if provided by the gateway. When provided, this must be
used for printing the merchant and customer receipts
}
ValidationError {
fieldName (string):
The name of the field that failed validation
,
errorMessages (Array[string]):
The error messages describing the reasons for failed validation
}
TransactionPaymentResponseData {
authorizedAmount (number):
The authorized amount of the transaction which may be less than the total
amount
,
subTotalAmount (number):
The original transaction amount of the request (inclusive of tax amount
but not tip amount)
,
tipAmount (number, optional):
The tip amount (if any sent in the request or captured on the payment
device)
,
surchargeAmount (number, optional):
The Surcharge amount for the transaction
,
totalAmount (number):
The total amount of the transaction (subtotal amount plus tip amount)
,
availableBalance (number, optional):
The available balance if returned by the gateway for the card type
}
GatewayResponseData {
decision (string, optional):
The decision returned by the gateway
,
code (string, optional):
The response code returned by the gateway
,
message (string, optional):
The response message returned by the gateway
,
processorCode (string, optional):
The processor response code returned by the gateway
,
processorMessage (string, optional):
The processor response message returned by the gateway
,
tokenCode (string, optional):
The token response code returned by the gateway, if any
,
tokenMessage (string, optional):
The token response message returned by the gateway, if any
,
authCode (string, optional):
The authorization code or approval number returned by the processor, if
any
,
cvvCode (string, optional):
The CVV code returned by the gateway, if any
,
processorCvvCode (string, optional):
The raw CVV code returned by the processor, if any
,
avsCode (string, optional):
The AVS code returned by the gateway, if any
,
processorAvsCode (string, optional):
The raw AVS code returned by the processor, if any
,
referenceId (string, optional):
The reference identifier returned by the gateway, if any
,
referenceCode (string, optional):
The client-generated reference code from the request, if any, or a value
generated on behalf of the client
,
reconciliationId (string, optional):
The reconciliation identifier returned by the gateway or processor, if
any
,
batchId (string, optional):
The batch identifier returned by the gateway, if any
}
CardInfo {
cardHolderName (string, optional):
The cardholder name, if available
,
accountNumberMasked (string):
The masked account number, e.g. first six and last four digits unmasked,
if available
,
cardIssuer (string, optional):
The card issuer, if available
= ['americanExpress', 'chinaUnionPay', 'dankort', 'dinersClub',
'discover', 'hipercard', 'jcb', 'maestro', 'masterCard', 'ruPay', 'visa',
'interac', 'wechat', 'alipay', 'eFTPOS', 'giftCard', 'bcCard', 'kwangju',
'jeonbuk', 'jeju', 'suhyup', 'hanmi', 'citi', 'shinsegae', 'hyundai',
'kbCard', 'kebHana', 'hana', 'lotte', 'lotteDongyang', 'nhCard',
'samsung', 'shinhan', 'woori', 'kakaoPay', 'naverPay', 'carteBancaire',
'electron', 'swile', 'unknown']
stringEnum:"americanExpress", "chinaUnionPay", "dankort", "dinersClub",
"discover", "hipercard", "jcb", "maestro", "masterCard", "ruPay", "visa",
"interac", "wechat", "alipay", "eFTPOS", "giftCard", "bcCard", "kwangju",
"jeonbuk", "jeju", "suhyup", "hanmi", "citi", "shinsegae", "hyundai",
"kbCard", "kebHana", "hana", "lotte", "lotteDongyang", "nhCard",
"samsung", "shinhan", "woori", "kakaoPay", "naverPay", "carteBancaire",
"electron", "swile", "unknown"
,
cardIssuerExtension (string, optional):
The card issuer extension, if available
,
cardType (string, optional):
The card type, if available
= ['credit', 'debit', 'giftCard', 'unknown']
stringEnum:"credit", "debit", "giftCard", "unknown"
,
entryMode (string, optional):
The entry mode, if available
= ['keyed', 'swiped', 'contactless', 'chip', 'contactlessChip',
'unknown']
stringEnum:"keyed", "swiped", "contactless", "chip", "contactlessChip",
"unknown"
,
expirationYearMonth (string, optional):
The expiration year and month (format YYYYMM), if available
,
correlationId (string, optional):
The correlation id, if available
}
EmvInfo {
isFallback (boolean):
Specifies if the EMV card was processed using fallback, e.g. if the chip
was defective and the card was swiped instead
,
mode (string, optional):
The EMV transaction decision mode that specifies how the decision
(approved or declined) was performed (by card or online by issuer)
= ['card', 'issuer']
stringEnum:"card", "issuer"
,
applicationIdentifier (string, optional):
The EMV application identifier (AID), as obtained from EMV tag 4F, if the
card was processed as EMV
,
applicationLabel (string, optional):
The EMV application label, as obtained from EMV tag 50, if the card was
processed as EMV
,
applicationPreferredName (string, optional):
The EMV application preferred name, as obtained from EMV tag 9F12, if the
card was processed as EMV
,
issuerCodeTableIndex (string, optional):
The EMV issuer code table index, as obtained from EMV tag 9F11, if the
card was processed as EMV
,
issuerApplicationData (string, optional):
The EMV issuer application data (IAD), as obtained from EMV tag 9F10, if
the card was processed as EMV
,
cryptogram (string, optional):
The EMV cryptogram as obtained from EMV tag 9F26, if the card was
processed as EMV
,
terminalVerificationResults (string, optional):
The EMV terminal verification results (TVR), as obtained from EMV tag 95,
if the card was processed as EMV
,
transactionStatusInformation (string, optional):
The EMV transaction status information (TSI), as obtained from EMV tag
9B, if the card was processed as EMV
,
authorizationResponseCode (string, optional):
The EMV authorization response code (ARC) as obtained from EMV tag 8A, if
the card was processed as EMV
,
tags (Array[EmvTag], optional):
The EMV tags, if the card was processed as EMV and the chip declined the
transaction
}
ReceiptData {
merchantReceiptText (Array[string], optional):
The merchant receipt text lines, if provided by the gateway. When
provided, this text must be used on the merchant receipt. Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
,
customerReceiptText (Array[string], optional):
The customer receipt text lines, if provided by the gateway. When
provided, this text must be used on the customer receipt Each text line
is encoded as UTF-8 and does not contain any embedded line breaks. For
more information, see section 7 of https://tools.ietf.org/html/rfc7159
}
EmvTag {
id (string):
The EMV tag ID
,
value (string, optional):
The EMV tag value
}
{
"code": 0,
"reason": "clientInvalidRequest",
"message": "string",
"debugMessage": "string",
"validationErrors": [
{
"fieldName": "string",
"errorMessages": [
"string"
]
}
],
"transactionState": "string",
"transactionResponseData": {
"authorizedAmount": 0,
"subTotalAmount": 0,
"tipAmount": 0,
"surchargeAmount": 0,
"totalAmount": 0,
"availableBalance": 0
},
"gatewayResponseData": {
"decision": "string",
"code": "string",
"message": "string",
"processorCode": "string",
"processorMessage": "string",
"tokenCode": "string",
"tokenMessage": "string",
"authCode": "string",
"cvvCode": "string",
"processorCvvCode": "string",
"avsCode": "string",
"processorAvsCode": "string",
"referenceId": "string",
"referenceCode": "string",
"reconciliationId": "string",
"batchId": "string"
},
"cardInfo": {
"cardHolderName": "string",
"accountNumberMasked": "string",
"cardIssuer": "americanExpress",
"cardIssuerExtension": "string",
"cardType": "credit",
"entryMode": "keyed",
"expirationYearMonth": "string",
"correlationId": "string"
},
"emvInfo": {
"isFallback": true,
"mode": "card",
"applicationIdentifier": "string",
"applicationLabel": "string",
"applicationPreferredName": "string",
"issuerCodeTableIndex": "string",
"issuerApplicationData": "string",
"cryptogram": "string",
"terminalVerificationResults": "string",
"transactionStatusInformation": "string",
"authorizationResponseCode": "string",
"tags": [
{
"id": "string",
"value": "string"
}
]
},
"pinVerified": true,
"signatureStatus": "unknown",
"receiptData": {
"merchantReceiptText": [
"string"
],
"customerReceiptText": [
"string"
]
}
}
Hide Response
CURL
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: , API VERSION: V1 ]